Changeset 1372 for trunk/psLib/src/mainpage.dox

Timestamp:

Aug 3, 2004, 10:42:30 AM (22 years ago)

Author:

desonia

Message:

* empty log message *

File:

• trunk/psLib/src/mainpage.dox (modified) (4 diffs)

trunk/psLib/src/mainpage.dox

@@ -1 @@
-/** @mainpage psLib Image Processing Library
-
+/** @mainpage psLib Image Processing Library - Release 2
 
 @section intro Introduction
 
-This library contains the Pan-STARRS Image Processing Pipeline (IPP) toolkit,
-psLib. The intended use is to provide a library of basic software functions which
+This library contains the Pan-STARRS Image Processing Pipeline (IPP) common library,
+psLib. The intended use is to provide a set of basic software functions in which
 can be used throughout the Pan-STARRS project to simplify programming tasks. Among
-the benefits are: reuse of code, simplification of testing, streamlining of code, 
-and isolation of functionality that may be subject to change.     
+the benefits are: 
+ - reuse of code, 
+ - simplification of testing, 
+ - streamlining of code, and 
+ - isolation of functionality that may be subject to change.     
 
 The capabilities provided by psLib are grouped into the following areas which are
 also reflected in the file system directory structure:
  - System Utilities
+ - Data Collections
  - Image Operations
- - Data Collections
  - Data Manipulation
  - Astronomy
@@ -21 +23 @@
 data types of the earlier entries.
 
-The installed code for psLib consists of header files and binary libraries in the form of static
-(libpslib.a) and shared (libpslib.so or libpslib.dylib for OX/X.) Assuming these components 
-have been built and installed in the standard library path, psLib may be used within a program by 
-including the line #include <pslib.h> and linking with -lpslib.
-
+The installed code for psLib consists of header files and binary libraries in 
+the form of static (libpslib.a) and shared (libpslib.so or libpslib.dylib, 
+depending on operating system.) Assuming these components have been built and 
+installed in the standard library path, psLib may be used within a program by 
+including the line #include <pslib.h> and linking using the '-lpslib' option
+while linking.
 
 
 @section extinstall Required 3rd Party Libraries
 
-Before building psLib from source, several 3rd party software libraries must be installed. 
-These include: 
- - GNU Scientific Library (GSL), Available at http://www.gnu.org/software/gsl
- - Fastest Fourier Transform in the West (FFTW), Available at http://www.fftw.org
- - C Flexible Image Transport System Input output (CFITSIO), Available at http://heasarc.gsfc.nasa.gov/docs/software/fitsio
+Before building psLib from source, several 3rd party software libraries must 
+be installed.  These include: 
+ - GNU Scientific Library (GSL)
+     - Compatibility tested with version is 1.4
+     - Available at http://www.gnu.org/software/gsl
+ - Fastest Fourier Transform in the West (FFTW), version 3
+     - Compatibility tested with version is 3.0.1
+     - Available at http://www.fftw.org
+ - C Flexible Image Transport System Input output (CFITSIO), version 2.480 or later
+     - Available at http://heasarc.gsfc.nasa.gov/docs/software/fitsio
+     - Compatibility tested with version is 2.490
+     - Versions earlier than 2.480 will not work as new functionality introduced in 2.480 is exercised
+ - Doxygen Documentation System
+     - Available at http://www.doxygen.org
+     - Compatibility tested with version 1.3.6
 
-If you use a Darwin (Mac OS X) system, a dlfcn compatability library needs to be
-installed on the system. This can be obtained from the Fink project on SourceForge 
-(the dlcompat package at http://www.sf.net/projects/fink). The Darwin 7.0 (OS X 10.3) 
-'devtools' package seems to also include dlfcn support, so explicit installation of a 
-dlfcn compatibility layer may not be required for this version of Darwin. 
-
+We recommend using the particular versions listed as compatibility tested, as 
+that is the only versions of the external libraries tested to work well with psLib.  
+Though it is quite possible that later versions of the libraries listed will also 
+work as well, care must be taken when upgrading these libraries to verify that its
+functionality is compatible with the tested version.
 
 @section install How to Build from Source
 
 The psLib code should to be downloaded from either the tar file posted on: 
-https://gforge.mhpcc.hawaii.edu/projects/panstarrs/ or directly from the CVS server 
-with the following command:
+
+https://mhpcc.pan-starrs.org/cgi-bin/viewcvs.cgi/releases/rel2
+
+or directly from the CVS server with the following command:
 <pre>
-$ cvs -d:ext:username@gforge.mhpcc.hawaii.edu:data/panstarrs/cvsroot co -P psLib
+$ cvs -d:ext:username@mhpcc.pan-starrs.org:/data/panstarrs/cvsroot co -r rel2_0 psLib
 </pre>
 
     
-The source should build from the Makefile in the psLib/src directory.  The
+The source should build using the Makefile in the psLib/src directory.  The
 recommended steps are:
 <pre>
+$ cd psLib/src
 $ make
 $ make install
@@ -62 +77 @@
 
 
-@section run How to Run Tests
+@section run How to Build and Run Tests
 
-Since psLib is a library, there is no executable, per se. However, to test the installation, users
-may execute the FullUnitTest script:
+Since psLib is a library, there is no executable, per se. However, to test the 
+installation, users may execute the the unit test suite.  To build the unit test
+suite, do the following:
 <pre>
 $ cd psLib/test
 $ make
 $ make install
-$ FullUnitTest
+$ make installtests
 </pre>
-<i>This builds and executes test files for each of the psLib functional areas.</i>
+<i>This builds and installs the unit test files to the psLib/testbin directory.</i>
 
+To run the unit test suite, do the following:
+<pre>
+$ cd psLib/testbin
+$ ./FullUnitTest
+</pre>
+or to run a particular test
+<pre>
+$ ./runTest testfilename
+</pre>
 
-@section doc How to Create Documentation
+@section doc How to Create Code Documentation
 
-Both HTML and man page documentation may also be generated:
+Both HTML and man page documentation may also be generated from the inline 
+documentation in the code using the following commands:
 <pre>
 $ cd psLib/src
@@ -84 +110 @@
 <i>This places documentation in psLib/docs.</i>
 
+Also, a prebuilt set of documentation can be found at:
+
+https://mhpcc.pan-starrs.org/docs/
+
 */