README file for MADIS documentation directory MADIS Version 3.9 September 29, 2009 -------------------------------------------------------------------------------- For the most current documentation (which can be updated outside of the version release cycle), go to: http://madis.noaa.gov/madis_api_doc.html That link will contain an index of links to the files in the doc directory, and show which ones have been changed since the current version release. System ------ INSTALL.unix How to install for Unix or Linux INSTALL.windows How to install for Windows README General package description README.doc_directory Explanation of doc directory files and Web updates RELEASE_NOTES Chronology of changes for all versions errors.txt Error codes, messages, corrective action hydro_providers.txt Hydro data providers available from FSL map_providers.txt Multi-agency profiler providers available from FSL rdmtr_providers.txt Radiometer providers available from FSL satrad_providers.txt Satellite radiance providers available from FSL satsnd_providers.txt Satellite soundings providers available from FSL satwnd_providers.txt Satellite wind providers available from FSL sfc_providers.txt Sfc data providers available from FSL snow_providers.txt Snow providers available from FSL Utility Programs ---------------- acarsdump_usage.txt The *usage.txt files describe how to run each acarspdump_usage.txt dump utility, how to set up the parameter files, hydrodump_usage.txt etc. mapdump_usage.txt npndump_usage.txt raobdump_usage.txt rdmtrdump_usage.txt satraddump_usage.txt satsnddump_usage.txt satwnddump_usage.txt sfcdump_usage.txt snowdump_usage.txt wisdomdump_usage.txt acarsdump.par Sample parameter files for each dump utility, acarspdump.par these will dump all variables with default hydrodump.par settings on all options. mapdump.par npndump.par raobdump.par rdmtrdump.par satraddump.par satsnddump.par satwnddump.par sfcdump.par snowdump.par wisdomdump.par hydrodump1.par Sample hydrodump.par - specific-provider option. mapdump1.par Sample mapdump.par - tabular output. mapdump2.par Sample mapdump.par - specific-provider option. npndump1.par Sample npndump.par - tabular output. raobdump1.par Sample raobdump.par - tabular output. rdmtrdump1.par Sample rdmtrdump.par - tabular output. rdmtrdump2.par Sample rdmtrdump.par - specific-provider option. satraddump1.par Sample satraddump.par - specific-provider option. satsnddump1.par Sample satsnddump.par - specific-provider option. satwnddump1.par Sample satwnddump.par - specific-provider option. sfcdump1.par Sample sfcdump.par file - mesonet-only variables. sfcdump2.par Sample sfcdump.par file - specific-provider option. snowdump1.par Sample snowdump.par - specific-provider option. Variables --------- acars_variable_list.txt The *variable_list.txt files list all variables acarsp_variable_list.txt available for each dataset, along with their hydro_variable_list.txt MADIS variable code names, units, and map_variable_list.txt explanatory notes. npn_variable_list.txt raob_variable_list.txt rdmtr_variable_list.txt satrad_variable_list.txt satsnd_variable_list.txt satwnd_variable_list.txt sfc_variable_list.txt snow_variable_list.txt wisdom_variable_list.txt QC Information -------------- qc_info.txt Description of the QC info that's available. acars_qc_variable_list.txt The *qc_variable_list.txt files list the QC acarsp_qc_variable_list.txt checks applied to the variables for each hydro_qc_variable_list.txt dataset. map_qc_variable_list.txt npn_qc_variable_list.txt raob_qc_variable_list.txt rdmtr_qc_variable_list.txt satrad_qc_variable_list.txt satsnd_qc_variable_list.txt satwnd_qc_variable_list.txt sfc_qc_variable_list.txt snow_qc_variable_list.txt wisdom_qc_variable_list.txt Programmer Documentation ------------------------ subroutine_list.txt List of MADIS routines. msetdom.txt Description of user-callable subroutines that msetwin.txt aren't demonstrated in the *dump programs. time_routines.txt