Administering OpenMadrigal

This document is meant as a manual for administering the OpenMadrigal web site. The OpenMadrigal web site serves a number of purposes:

  1. It distributes the latest version of Madrigal metadata and geophysical data to all the individual sites when they run updateMaster.
  2. It serves as a central web site to inform about the OpenMadrigal project, and to distribute the latest version of the code.

This manual also covers the building and testing of a new Madrigal release. All files relating to OpenMadrigal (including this document) are located in CVS under Millstone/Madrigal/OpenMadrigal.

Distributing Madrigal metadata and geophysical data

Two cron jobs are required to collect these data, createExpUpdate.py and createGeoUpdate.py.

createExpUpdate.py - located in CVS under Millstone/Madrigal/OpenMadrigal/scripts. Usage: createExpUpdate.py [-e emailAddress] [-e emailAddress2] ... where any number of email addresses can be notified of the results. This script collects the metadata files expTab.txt and fileTab.txt from each of the Madrigal sites listed in siteTab.txt, and stores them in the directory metadata/[site_name]_[site_id]. The site_name and site_id are also set by siteTab.txt. This cron job should be set to run at least once a day, and the results should be emailed to the OpenMadrigal administrator. The results are accessed via the web from the url http://www.haystack.mit.edu/madrigal/distributionFiles/metadata.

createGeoUpdate.py - located in CVS under Millstone/Madrigal/OpenMadrigal/scripts. Usage: createGeoUpdate.py [-e emailAddress] [-e emailAddress2] ... where any number of email addresses can be notified of the results.. This script will update the geofil.tar.Z and ig_rz.dat file on OpenMadrigal. Also updates the file status.dat which indicates the last update date of each type of geophysical data. All the files updated are accessed via the url http://www.haystack.mit.edu/madrigal/distributionFiles. Due to relatively infrequent updates to the base files, this cron job is now run only once a week.

Three core metadata files are also distributed via updateMaster:

The OpenMadrigal administrator is responsible for manually updating these three files on http://www.haystack.mit.edu/madrigal/distributionFiles/metadata whenever they are changed. You can set up up the script checkMetadataDist.py located in CVS under Millstone/Madrigal/OpenMadrigal/scripts as a cron job to check that these files are in sync.

The script checkMetadata.py can be set up as a cron job to monitor whether all Madrigal sites have these three up-to-date metadata files. The sites need to be running Madrigal 2.5 or greater in order to have automatic update of these files. This script is located in CVS under OpenMadrigal/madroot/source/madpy/scripts/bin.

Building a new release of Madrigal

Building a release

From CVS at Millstone, checkout OpenMadrigal/madroot. Since autotools is used in building a distribution, you want to be sure that your machine has up-to-date autotools. For Madrigal 2.5, I used autoconf 2.6.3, automake 1.10.2, libtool 2.2.4, and m4 1.4.12. To create the needed autotool files, cd to source and run:

  1. aclocal
  2. autoconf
  3. libtoolize
  4. autoheader
  5. automake --add-missing

To make the distribution file, cd to madroot, and run "make -f Makefile.gnu". The file MANIFEST in the madroot directory controls which files are included in the tar file. The general test procedure is to build the distribution, and then test install on any available unix machines, both as updates and as new installs. There are also regression tests to be run on the core C and Fortran libraries, and on the Python library.

Regression tests

A regression test for the C and Fortrans libraries is runMadrecDiagnostics, found in CVS under OpenMadrigal/madroot/source/madc/madrec. This regression test can also be run under purify. To do so build the Fortran library geolib with a debug flag. Then build the madrec library using the Makefile.purify file in the madrec directory.

The python regression tests are in OpenMadrigal/madroot/source/madpy/scripts/regressionTests. Each of the following three regression tests are run as $MADROOT/bin/python script:

Rebuilding the pdf documentation

To rebuilding all the Madrigal documentation into a single pdf file, cd $MADROOT/doc and run

htmldoc madDocBook.book

If you have added or removed any documentation files, or changed their order, you will need to use the htmldoc UI to make those changes. Also, in order to import the graphics into the generated pdf, you will need to make a temporary copy of the $MADROOT/icons directory in the $MADROOT/doc directory.


Revised: Jan 23, 2008