view release on metacpan or  search on metacpan

doc/INSTALL.pod  view on Meta::CPAN

the test scripts just to verify that everything is working as expected.

The exact location where SenseClusters will be installed depends
on your system configuration. A message will be printed out after
'make install' telling you exactly where it was installed. 

=head2 Local Installation of Core SenseClusters programs

If you are not able to log in as su or sudo (to be the root user), 
then you may need to install SenseClusters in a local directory that 
you own and have permissions to read and write into. You can proceed as 
above, except that you will need to provide PREFIX and LIB options for 
your Makefile.PL command, as in:

C<perl Makefile.PL PREFIX = /YOUR/DIR LIB=/YOUR/DIR/lib>

This will set up a Makefile that will install the core SenseClusters 
programs (*.pl) into C</YOUR/DIR/bin/>. You will need to set your path 
to specifically include this directory. 

The Sensecluster.pm module will be installed into C</YOUR/DIR/lib>. You 
will need to set your PERL5LIB environment variable to have this 
directory included in your @INC array (which defines the directories 
that Perl searches for modules).

You man pages will be installed in directories like  
C</YOUR/DIR/share/man/> (Linux) or C</YOUR/DIR/man/> (Solaris). You will 
need to set your MANPATH to include these. 

Note that the exact locations will be shown after executing 'make install'  
command. Please double check the recommended settings for PATH and MANPATH 
there as those will be tailored to your system. 

=head1 C SHELL (csh) SETUP 

If you install without root or superuser access, you will need to set 
the paths of the dependent packages mentioned previously. The following 
is an example of how you might set your paths before using  
SenseClusters if you are using the C shell (csh). If you use another 
shell then you will need to modify this accordingly. 

This assumes that Perl and PDL have been installed by your system  
administrator and you do not need to set paths to find them. In general 
we would recommend that Perl and PDL be installed with root access as 
it's more simple that way. 

Assume that all of the external C packages (SVDPACKC, Cluto) have been 
installed in directories beneath /space/kulka020 (our home directory 
for this example). It also assumes that all of the CPAN modules have 
been installed in /space/kulka020/MyPerlLib. In other words, it is 
assumed that all CPAN modules were installed via the following command: 		

C<perl Makefile.PL PREFIX=/space/kulka020/Text-SenseClusters-1.00 LIB=/space/kulka020/MyPerlLib>
 
 #######################################################################
 #    insert the following into ~/.cshrc and modify HOMEDIR and LIBHOME
 #######################################################################
 
 # local directory where we are installing everything
 
 setenv HOMEDIR /space/kulka020
 
 # library name extension used by Perl on our system

 setenv LIBDIR /space/kulka020/MyPerlLib
 
 # UMD developed code, we need to set their /bin directories in the PATH
 
 setenv SENSECLUSTERS $HOMEDIR/Text-SenseClusters-1.00
 setenv NSP $HOMEDIR/Text-NSP-1.09

 # externally developed C code, directories contain executable code so must 
 # be included in PATH
 
 setenv SVDPACK $HOMEDIR/SVDPACKC
 setenv CLUTO $HOMEDIR/cluto-2.1.1
 
 # pick the right version of Cluto (Solaris or Linux)
 
 set OSNAME=`uname -s`
 
 if ($OSNAME == "SunOS") then
        setenv MYCLUTO $CLUTO/Sun
 else if ($OSNAME == "Linux") then
        setenv MYCLUTO $CLUTO/Linux
 else echo "lost"
 endif
 
 # set the path that Perl searches for CPAN modules
 
 setenv PERL5LIB $LIBDIR

 # set the path that is searched for executables
 
 set AKPATH = ($SVDPACK $NSP/bin $MYCLUTO $SENSECLUSTERS/bin .)
 
 set path = ($AKPATH $path)

=head1 INSTALLING SenseClusters' Web-interface:

If you would like to setup the SenseClusters' web-interface locally 
please refer to L<README.Web.pod> for installation instructions.

=head1 SEE ALSO

The SenseClusters web page provides links to downloads, the web 
interface, documentation, and CVS directories: 

 L<http://senseclusters.sourceforge.net>

We have three mailing lists available for SenseClusters:

=over 

=item 

senseclusters-news provides announcements of new versions:
 L<http://lists.sourceforge.net/lists/listinfo/senseclusters-news>

=item 

senseclusters-users allows users to post questions or bug reports: 
 L<http://lists.sourceforge.net/lists/listinfo/senseclusters-users>

=item 

senseclusters-developers is for implementation related questions:
 L<http://lists.sourceforge.net/lists/listinfo/senseclusters-developers>

=back

=head1 AUTHORS

 Ted Pedersen, University of Minnesota, Duluth
 tpederse at d.umn.edu

 Anagha Kulkarni, Carnegie Mellon University

 Amruta Purandare, University of Pittsburgh

This document last modified by :
$Id: INSTALL.pod,v 1.16 2013/06/27 14:34:06 tpederse Exp $

=head1 COPYRIGHT

Copyright (c) 2004-2008, Ted Pedersen

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover