Differences

This shows you the differences between two versions of the page.

--- prorad:usage [2012-06-21 13:29:35]
mortens
+++ prorad:usage [2022-05-31 09:29:32] (current)
@@ Line 1: / Line 1: @@
-====== Configuration and use ======
+====== Configuration ======
-Work in progress
+We recommend that the ProRad software is run by a dedicated UID, and
+we have chosen to install the software in the home directory of such a
+user.  It may not be what your IT-department recommends, but as soon as you
+have familiarised yourself with the software you will know what to do
+to comply with rules and regulations of your organisation.
+Once you have built the software, all modules will be present in the
+'bin' directory in the directory where you built the software.  You
+may copy these files to wherever you wish.
+In the following example we assume you have a dedicated user for
+running the software, and that the software is installed in this users
+home directory.
+===== Basic installation =====
+We use the following setup for our installation.  Each release of the
+software is kept in a directory, named after the release:
+  drwxr-xr-x 29 uid uid 4096 2012-03-02 13:20 prorad-xml-1.3
+  drwxr-xr-x 29 uid uid 4096 2012-03-14 14:49 prorad-xml-1.3.1
+  drwxr-xr-x 29 uid uid 4096 2012-03-20 08:54 prorad-xml-1.3.2
+  drwxr-xr-x 29 uid uid 4096 2012-06-21 10:18 prorad-xml-1.3.2.1
+And we use a set of symlinks which can be quickly rearranged if we
+should detect problems and need to make a quick switch from one
+release to another:
+  lrwxrwxrwx  1 uid uid   18 2012-06-21 11:28 prorad -> prorad-xml-1.3.2.1
+and then we use this link to setup the symlink to the bin directory
+  lrwxrwxrwx  1 uid uid   10 2012-01-16 10:06 bin -> prorad/bin
+(This may seem a little counter intuitive, and it would be perfectly
+fine to just to point the bin symlink directly to the directory
+containing the current ProRad release.  Again, this is how we do
+things.  Feel free to deviate from this recommendation if you so
+wish.)
+We also keep a similar structure for the configuration files
+  drwxr-xr-x  8 uid uid 4096 2012-02-09 12:36 config-xml-1.3
+  drwxr-xr-x  8 uid uid 4096 2012-03-19 15:17 config-xml-1.3.1
+  drwxr-xr-x  8 uid uid 4096 2012-03-20 09:41 config-xml-1.3.2
+and here we aslo use a set of symlinks to point to various
+subdirectories within the configuration package
+  lrwxrwxrwx  1 uid uid   16 2012-03-29 16:26 prorad-config -> config-xml-1.3.2
+  lrwxrwxrwx  1 uid uid   17 2012-01-16 10:06 etc -> prorad-config/etc
+  lrwxrwxrwx  1 uid uid   21 2012-01-16 10:06 scripts -> prorad-config/scripts
+===== Diretories for storing datasets =====
+We have chosen to put the data files on a separate partition, and the
+directories listed here is a minimum configuration for a ProRad node
+performing volume filtering/QC, precipitation accumulations and making
+mosaics from 2D products
+  /disk1/proradfiles/
+  /disk1/proradfiles/permanent
+  /disk1/proradfiles/permanent/var-run
+  /disk1/proradfiles/permanent/foo-mask
+  /disk1/proradfiles/permanent/map-mask
+  /disk1/proradfiles/short-term
+  /disk1/proradfiles/short-term/reproj-files
+  /disk1/proradfiles/short-term/geotiff
+  /disk1/proradfiles/script-dirs
+  /disk1/proradfiles/script-dirs/images
+  /disk1/proradfiles/script-dirs/ftp-logs
+  /disk1/proradfiles/long-term
+  /disk1/proradfiles/long-term/mom-messages
+  /disk1/proradfiles/long-term/log4cxx
+  /disk1/proradfiles/long-term/prorad-acrr
+  /disk1/proradfiles/long-term/sched-acrr-filelists
+  /disk1/proradfiles/long-term/filtered-products
+  /disk1/proradfiles/long-term/mosaics
+  /disk1/proradfiles/long-term/prorad-import
+  /disk1/proradfiles/long-term/prodgen-products
+We have chosen make a distinction between datasets that can easily be
+recreated and those datasets that require more work to regenerate. The
+former are stored in the 'short-term' directory, the latter are stored
+in the 'long-term' directory. There is also a category of files which
+belong in the 'permanent' directory, these include datasets related to
+beam block calculations (not shown here) and PID-lock files stored by
+each module to prevent multiple instances with identical
+configurations to be started.