Changeset 5035 for trunk/psModules/src/mainpage.dox

Timestamp:

Sep 13, 2005, 11:18:21 AM (21 years ago)

Author:

desonia

Message:

updated for release.

File:

• trunk/psModules/src/mainpage.dox (modified) (5 diffs)

trunk/psModules/src/mainpage.dox

@@ -11 +11 @@
 Modules in this release include:
 
+ - Astrometry (pmAstrometry)
  - Subtract bias (pmSubtractBias)
  - Correct for non-linearity (pmNonLinear)
  - Flat-field (pmFlatField)
- - Mask bad pixels (pmMaskBadPixels)
+ - Mask bad pixels (pmMaskBadPixels and pmMaskBadPixelsErrors)
+ - Image Combine (pmImageCombine)
+ - Image Subtract (pmImageSubtract)
  - Combine readouts (pmReadoutCombine)
  - Subtract sky (pmSubtractSky)
@@ -47 +50 @@
 https://mhpcc.pan-starrs.org/code/releases
 
-Though MHPCC recommends using the released packaged tar files descibed above,
-both daily development snapshots and direct CVS access is available.  The daily
-snapshots are available at
-
-https://mhpcc.pan-starrs.org/code/snapshots
-
-These snapshots represents development code as found in CVS on the day
-specified in the filename.  This code set may not be functional, vary in
-testing, etc.  Reasonable efforts are made to ensure that the code does
-actually compile, but given the nature of code development, even that is not
-always the case.  Use snapshots with great caution.
-
 If one has a login account on mhpcc.pan-starrs.org, direct CVS access is
 possible.  Example of the commands required for direct CVS retrieval are
@@ -67 +58 @@
 where:
   - USERNAME is your login name on the server
-  - RELEASEBRANCH is the desired release branch, e.g. rel5.
+  - RELEASEBRANCH is the desired release branch, e.g. rel7.
 
 
@@ -85 +76 @@
 <i>Unless otherwise specified, the library is installed with PREFIX of the current directory.</i>
 
+If the code was retrieved from CVS, you will need to substitute 'autogen.sh' for 'configure' in
+above example.
+
 Other configuration options, such as location of external libraries, are also available.
 To get a list of options, type the following in the top psModule directory.
@@ -91 +85 @@
 </pre>
 A likely option needed is '--with-pslib-config', which specifies the location of
-the configuration script for psLib.  By default, iconfigure searches for it using PATH, but that
-is often not sufficient.
+the configuration script for psLib.  By default, configure searches for it using PATH, but that
+is not always sufficient.
+
+@section install How to Install
+
+To install the library using the prefix given in the configure step, execute in
+the top build directory:
+<pre>
+$ make install
+</pre>
+
+
+@section usage Building and Linking your code to the psModule library
+
+To assist the use of the library with your own code, a configuration tool is part
+of the psModule library package.  This tool, psmodule-config, is installed in the BIN
+directory, according to the options given to the configure script.
+
+The required CFLAG options for the compiler stage of code that uses psModule can be
+obtained via 'psmodule-config --cflags'.  This outputs the cc options that supplies
+include path(s) required to find the psModule headers.
+
+The required linking options, can be obtained via 'psmodule-config --libs'.  This
+outputs the ld options that supplies the library paths and files required to
+link to the psModule library.
+
+Note: psmodule-config usage above refers to the install locations of the library.  
 
 @section doc How to Create Code Documentation