Skip to content

readme_usage.md

Latest commit

 

History

History
67 lines (49 loc) · 2.4 KB

readme_usage.md

File metadata and controls

67 lines (49 loc) · 2.4 KB
Raw

Readme usage details

Usage

You can install the project if you haven't already with

  pip install git+https://github.com/usgs/geomag-algorithms.git

Running geomag.py -h or geomag.py --help will show an extensive list of input parameters.

Some of the key parameters that should be specified are listed here along with examples. They include

  • start time - YYYY-MM-DDTHH:MM:SSZ
  • end time - YYYY-MM-DDTHH:MM:SSZ
  • observatory code - 3-letter observatory code
  • data input source - {--input-edge, --input-iaga-file, ...}
  • data output source - {--output-pcdcp-url, --output-iaga-file, ...}
  • input data channels - {[CHANNEL [CHANNEL ...]]}
  • output data channels - {[CHANNEL [CHANNEL ...]]}
  • data type - {variation, quasi-definitive, definitive}
  • interval - {minute, second, hour, day}

Examples

To retrieve all raw (variation) H, E, Z and F minute data from Boulder Observatory for the entire day of July 1st 2014 from an iaga2002 formatted file and output H, E, Z and F data to a PCDCP formatted file:

  geomag.py --type variation --inchannels H E Z F --interval minute \
  --observatory BOU \
  --starttime 2014-07-01T00:00:00Z \
  --endtime 2014-07-01T23:59:00Z \
  --input-iaga-file BOU20140701vmin.min \
  --outchannels H E Z F \
  --output-pcdcp-file BOU2014182.min

To retrieve all raw (variation) H, E, Z and F minute data from Tucson Observatory for the entire month of March 2013 from pcdcp formatted files in a "data-pcdcp" directory and output H, E, Z and F data to a group of iaga2002 formatted files in a "data-iaga" directory:

  geomag.py --type variation --inchannels H E Z F --interval minute \
  --observatory TUC \
  --starttime 2013-03-01T00:00:00Z \
  --endtime 2013-03-31T23:59:00Z \
  --input-pcdcp-url file://data-pcdcp/./%(OBS)s%(year)s%(julian)s.%(i)s \
  --output-iaga-url file://data-iaga/./$(obs)s%(Y)s%(j)s.%(i)s \
  --outchannels H E Z F

Algorithms

There are flags to specify certain algorithms should be run against the data.

XYZ

--xyz {geo, mag, obs, obsd} {geo, mag, obs, obsd}

XYZ Usage

Rotate data from HEZ or HDZ to XYZ and back.

Extensive explanation of all input and output methods: IO Methods