diff --git a/docs/XYZ_usage.md b/docs/XYZ_usage.md index 4857a7730e87e24c28df4b52f7f5fc45b8d41dd6..987313bcd7c124d2c4d510478ff5ecc11441b866 100644 --- a/docs/XYZ_usage.md +++ b/docs/XYZ_usage.md @@ -1,7 +1,7 @@ # XYZ Usage # -geomag.py --xyz {geo, mag, obs, obsd} {geo, mag, obs, obsd} +`geomag.py --xyz {geo, mag, obs, obsd} {geo, mag, obs, obsd}` ### Reference Frames ### @@ -31,16 +31,13 @@ There are 3 reference frames in this library. To convert HEZF data in pcdcp files to XYZF for Tucson observatory for all of March 2013 output to iaga2002 files: - geomag.py --xyz obs geo --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 - --type variation --interval minute + geomag.py --xyz obs geo --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 --type variation --interval minute + --- ### Library Notes ### -> Note: within this library all channels are uppercase. +> Note: Within this library all channels are uppercase. > We use context (ie obs vs. mag vs geo), to differentiate between h,H; e,E; > and d,D. This mirrors the various data formats, (ie IAGA2002, etc). @@ -56,6 +53,7 @@ These are provided by `geomagio.StreamConverter`. > Note: this library internally represents data gaps as NaN, and factories > convert to this where possible. +--- ### [Algorithm Theoretical Basis for "Geomag XYZ"](XYZ.md) ### Describes the theory behind the XYZ algorithm, as well as some implementation issues and solutions. diff --git a/readme_dependency_install.md b/readme_dependency_install.md index 9f58300471c79f5ad85b64d5541f584cf9a4128b..06f9eb107adeacae06ed485da422d0e3a64ec1db 100644 --- a/readme_dependency_install.md +++ b/readme_dependency_install.md @@ -9,7 +9,7 @@ specific dependency information. 1. Install __geomagio__ - pip install git+https://github.com/usgs/geomag-algorithms.git + pip install git+https://github.com/usgs/geomag-algorithms.git 1. Use __geomagio__ diff --git a/readme_usage.md b/readme_usage.md index 23bcdf95d4016b082cb15d1327cea54c6c9d1092..289dc7a99229dcdd076d63de3bb4d36850873374 100644 --- a/readme_usage.md +++ b/readme_usage.md @@ -29,37 +29,26 @@ _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 + 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 + 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 +`--xyz {geo, mag, obs, obsd} {geo, mag, obs, obsd}` -##### [XYZ Usage](./docs/XYZ_usage.md) ##### +#### [XYZ Usage](./docs/XYZ_usage.md) #### Rotate data from HEZ or HDZ to XYZ and back. Extensive explanation of all input and output methods: