Skip to content
Snippets Groups Projects
Commit e368b8b5 authored by Eddie McWhirter's avatar Eddie McWhirter
Browse files

Add XYZ usage.

parent fdcadfb8
No related branches found
No related tags found
No related merge requests found
......@@ -3,21 +3,25 @@ Geomag Algorithms
Geomag algorithms includes tools to fetch, process, and output geomag data.
### [First Time Install](readme_dependency_install.md) ###
Requires Python
### [Install](readme_dependency_install.md) ###
First time install walks through dependencies and other considerations.
The project requires Python.
### [Development Dependencies](readme_develop_install.md) ###
Uses Grunt and Node
### [Develop](readme_develop_install.md) ###
Development dependencies are discussed here.
Uses Grunt and Node.
### [Usage](readme_usage.md) ###
Details and examples for proper usage.
Basic usage:
- Use the main script, `geomag.py -h`.
- In python scripts, `import geomagio`.
Supported Algorithms
--------------------
## [XYZ Algorithm](./docs/XYZ.md) ##
### [XYZ Algorithm](./docs/XYZ_usage.md) ###
[Documentation](./docs/README.md)
......
# XYZ Usage #
--xyz {geo, mag, obs, obsd} {geo, mag, obs, obsd}
'geo': ['X', 'Y', 'Z', 'F'],
'mag': ['H', 'D', 'Z', 'F'],
'obs': ['H', 'E', 'Z', 'F'],
'obsd': ['H', 'D', 'Z', 'F']
geomag.py --xyz geo 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
```
Background information with equations and implementation details:
[XYZ Background](XYZ.md)
......@@ -45,5 +45,12 @@ geomag.py --type variation --inchannels H E Z F --interval minute
--outchannels H E Z F
```
### Algorithms ###
There are flags to specify certain algorithms should be run against the data.
#### XYZ ####
[XYZ Usage](./docs/XYZ_usage.md)
Extensive explanation of all input and output methods
[IO Methods](readme_io.md)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment