Changeset 2142

Timestamp:

Oct 14, 2004, 3:11:59 PM (22 years ago)

Author:

desonia

Message:

cleanup.

Location:

trunk/psModules/src

Files:

• Makefile.am (modified) (1 diff)
• Makefile.in (modified) (1 diff)
• mainpage.dox (modified) (5 diffs)

trunk/psModules/src/Makefile.am

@@ -3 +3 @@
 libpsmodule_a_SOURCES = pmFlatField.c pmMaskBadPixels.c pmSubtractBias.c psTest.c pmSubtractBias.c pmNonLinear.c
 libpsmodule_a_HEADERS = pmFlatField.h pmMaskBadPixels.h pmSubtractBias.h psTest.h pmSubtractBias.h pmNonLinear.h
-libpsmodule_adir = .
+libpsmodule_adir = $(includedir)

trunk/psModules/src/Makefile.in

@@ -181 +181 @@
 libpsmodule_a_SOURCES = pmFlatField.c pmMaskBadPixels.c pmSubtractBias.c psTest.c pmSubtractBias.c pmNonLinear.c
 libpsmodule_a_HEADERS = pmFlatField.h pmMaskBadPixels.h pmSubtractBias.h psTest.h pmSubtractBias.h pmNonLinear.h
-libpsmodule_adir = .
+libpsmodule_adir = $(includedir)
 all: config.h
         $(MAKE) $(AM_MAKEFLAGS) all-am

trunk/psModules/src/mainpage.dox

@@ -3 +3 @@
 
 @section intro Introduction
-This library contains the Pan-STARRS Image Processing Pipeline (IPP) image processing modules. These modules
+This library contains the Pan-STARRS Image Processing Pipeline (IPP) modules (psModule). These modules
 use the functionality of the Pan-STARRS Library (psLib) to perform more complex tasks associated with image 
 processing. Modules were constructed to support each of the required processing stages, and are listed according 
-to the particular processing  stage for which they will primarily be used. To preserve space, globally-visible 
+to the particular processing stage for which they will primarily be used. To preserve namespace, globally-visible 
 structures and functions are prefixed with pm, an abbreviation for Pan-STARRS Modules.
 
@@ -41 +41 @@
      - The optional companion package, GraphViz (a.k.a., the 'dot' command), is recommended to enable header-file dependency diagrams
  - SLALIB 
-     - We tested with the Fortran version of the library; this may cause an additional step to get things to link on untested systems/compilers, as there is no one standard for how the function-names appear in the library to C code.  The default way that psLib uses is all-lower case with a trailing '_', but one may need to add to CFLAGS in src/Makefile.Globals the following:
-         - '-DFORTRAN_UNDERSCORE_PREFIX' if a '_' needs to be prefixed to the function names,
-         - '-DFORTRAN_DOUBLE_UNDERSCORE_SUFFIX' if two the names needs two trailing '_'s., and/or
-         - '-DFORTRAN_UPPERCASE' if the names appear as uppercase.
      - Available at http://star-www.rl.ac.uk/
      - Compatibility tested with package version number 2.4-12
 
 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.
+that is the only versions of the external libraries tested to work well with psLib
+and psModule.  Though it is quite possible that later versions of the libraries 
+listed will also work, 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
@@ -76 +72 @@
 as follows:
 <pre>
-$ cvs -d:ext:USERNAME@mhpcc.pan-starrs.org:/data/panstarrs/cvsroot co -r RELEASEBRANCH psLib
+$ cvs -d:ext:USERNAME@mhpcc.pan-starrs.org:/data/panstarrs/cvsroot co -r RELEASEBRANCH psModule
 </pre>
 where:
   - USERNAME is your login name on the server
-  - RELEASEBRANCH is the desired release branch, e.g. rel1, rel2, etc.
+  - RELEASEBRANCH is the desired release branch, e.g. rel1.
     
 
 @section build How to Build the psModule library.
+
+The psModule library and associated tests are made via the GNU autoconf/automake system.
 
 The source should build using the configure script in the psModule directory.  The
@@ -89 +87 @@
 <pre>
 $ cd psModule
-$ configure --with-psLib=/home/harman/psLib (Directory for psLib will vary)
+$ configure --with-psLib=/home/kaiser/psLib (NB: Directory for psLib will vary)
 $ make 
-$ make install
 </pre>
 <i>This builds and installs files to psModule/lib and psModule/include.</i>
 
+Other configuration options, such as location of other 3rd party libraries, are also available.
+To get a list of options, type the following in the top psModule directory.
+<pre>
+$ configure --help
+</pre>
 
 @section run How to Build and Run Tests
 
-To test the installation, users may execute the unit tests which are automatically built
+To test the installation, users may execute the unit tests which was automatically built
 when the user performs a make from the psModule directory.
 <pre>
 $ cd psModule/test
-$ tst_pmFlatField
-$ tst_pmMaskBadPixels  
-$ tst_pmNonLinear
-$ tst_pmSubtractBias
+$ ./FullUnitTest
 </pre>
-<i>This builds and installs the unit test files to the psLib/testbin directory.</i>
 
 @section doc How to Create Code Documentation
@@ -115 +113 @@
 <pre>
 $ cd psModule/src
-$ doxygen Doxyfile
+$ doxygen
 </pre>
 <i>This places documentation in psModule/docs.</i>