[OpenMadrigal-developers] Plans for the MadrigalWeb python module

[William Rideout]

I am starting to write an entirely new Python module, called MadrigalWeb.  The 
goal of this module will be to access Madrigal data entirely via the web using 
the newly-added web services.  These web service are the major feature of the 
soon-to-be released next version of Madrigal (2.3).  This module will not 
require any other software to be installed. In particular, this module will not 
require the Madrigal server to be installed on the local machine or on any 
machine that the client can access except via the web.  It will be designed and 
tested to work both on Unix and Windows machines.  The code will be very similar 
to the Madrigal Matlab *Web methods (except with far fewer lines of code).  It 
will be written in 100% python (no C extensions needed).

The first application that will use the MadrigalWeb module will be 
globalIsprint, an application that reproduces the functionality of the global 
search web pages.  Below is the documentation for that application:

Usage:

globalIsprint --url=<Madrigal url> --parms=<Madrigal parms>
               --output=<output file> [options]

where:

--url=<Madrigal url> - url to homepage of site to be searched
                           (ie, http://www.haystack.mit.edu/madrigal/)
                           This is required.

--parms=<Madrigal parms> - a comma delimited string listing the desired Madrigal
                            parameters in mnemonic form.  (Example:
                            gdalt,dte,te).  Data will be returned
                            in the same order as given in this string.

--output=<output file name> - the file name to store the resulting data.


and options are:


--startDate=<MM/DD/YYY> - start date to filter experiments before.  Defaults to
                           allow all experiments.

--endDate=<MM/DD/YYY> - end date to filter experiments after.  Defaults to allow
                         all experiments.

--inst=<instrument list> - comma separated list of instrument codes or names.
                            See Madrigal documentation for this list.  Defaults
                            to allow all instruments. If names are given, the
                            argument must be enclosed in double quotes.

                            Examples::

                                --inst=10,30

                                --inst="Jicamarca IS Radar,Arecibo IS Radar"

--kindat=<kind of data list> - comma separated list of kind of data codes.  See
                                Madrigal documentation for this list.  Defaults
                                to allow all kinds of data.  If names are given,
                                the  argument must be enclosed in double quotes.

                                Examples::

                                     --kindat=3001,13201

                                     --kindat="INSCAL Basic Derived
                                       Parameters,(efwind) Derived Parameters:
                                       E+F regions: winds/electric fields/ion
                                       drifts"

--filter=<filter>=<[mnemonic] or [mnemonic1,[+-*/]mnemonic2]>,<lower
                     limit1>,<upper limit1>[or<lower limit2>,<upper limit2>...]

                     a filter using any measured or derived Madrigal parameter,
                     or two Madrigal parameters either added, subtracted,
                     multiplied or divided.  Each filter has one or more allowed
                     ranges.  The filter accepts data that is in any allowed
                     range.  If the Madrigal parameter value is missing, the
                     filter will always reject that data.  Multiple filter
                     arguments are allowed on the command line.  To skip either a
                     lower limit or an upper limit, leave it blank.  Examples::


                         filter=ti,500,1000  (Accept when 500 <= Ti <= 1000)

                         filter=gdalt,-,sdwht,0,  (Accept when gdalt >
                            shadowheight - that is, point in direct sunlight)

                         filter=gdalt,200,300,1000,1200 (Accept when 200 <= gdalt
                           <= 300 OR 1000 <= gdalt <= 1200)

--seasonalStartDate=<MM/DD> - seasonal start date to filter experiments before.
                               Use this to select only part of the year to
                               collect data.  Defaults to Jan 1.  Example:
                               --seasonalStartDate=07/01 would only allow
                               experiments after July 1st from each year.


--seasonalEndDate=<MM/DD> - seasonal end date to filter experiments after.  Use
                             this to select only part of the year to collect
                             data.  Defaults to Dec 31.  Example:
                             --seasonalEndDate=10/31 would only allow
                             experiments before Oct 31 of each year.

--showFiles - if given, show file names.  Default is to not show file names.

--showSummary - if given, summarize all arguments at the beginning.  Default is
                 to not show summary.

Let me know if you have any comments.

Bill

-- 
Bill Rideout
MIT Haystack Observatory
Email: brideout at haystack.mit.edu
Phone: 781 981-5624