diff --git a/README.md b/README.md index 29ea362b5e07cecbbea442ff195137fb27d48cdb..969d24c6030d3ed5b582610e6b168574a2ad45cf 100644 --- a/README.md +++ b/README.md @@ -3,38 +3,42 @@ Geomag Algorithms Geomag algorithms includes tools to fetch, process, and output geomag data. -### [Install](readme_dependency_install.md) ### -First time install. Walk through dependencies and other considerations. +## Supported Formats ## -### [Develop](readme_develop_install.md) ### -Development dependencies discussed here. Project is built with Grunt and Node -and is written primarily in Python 2.7. +### [Edge](readme_io.md#edge) ### -### [Usage](readme_usage.md) ### -Details and examples for proper usage. This will help you get started quickly. +Use an Edge server for data input. -Basic usage: +### [IAGA](readme_io.md#iaga2002)### - - Use the main script, `geomag.py -h` - - In python scripts, `import geomagio` +Use IAGA2002 formatted files for input and/or output. + +### [PCDCP](readme_io.md#) ### + +Use PCDCP formatted files for input and/or output. -Supported Algorithms --------------------- -### [XYZ Algorithm](./docs/XYZ_usage.md) ### +--- +## Supported Algorithms ## + +### [XYZ](./docs/XYZ_usage.md) ### +Rotate data between coordinate systems. From HEZ or HDZ to XYZ and back. --- -Coding Standards ----------------- +## Getting Started ## -This project adheres to PEP8 standards in most cases: - https://www.python.org/dev/peps/pep-0008 +### [Install](readme_dependency_install.md) ### +First time install. Walk through dependencies and other considerations. -### PEP8 Exceptions ### +### [Use](readme_usage.md) ### +Details and examples for proper usage. Get started quickly. -- Hanging/Visual indents (E126, E127, E128, E131) +Basic usage: - - line continuations should use two indentations (8 spaces). - - do not use visual indents. + - Use the main script, `geomag.py -h` + - In python scripts, `import geomagio` +### [Develop](readme_develop_install.md) ### +Development dependencies discussed here. Project is built with Grunt and Node +and is written primarily in Python 2.7. diff --git a/docs/XYZ_usage.md b/docs/XYZ_usage.md index 987313bcd7c124d2c4d510478ff5ecc11441b866..aa0fd9187f2a92013ce66b9a39358dc07771f7e4 100644 --- a/docs/XYZ_usage.md +++ b/docs/XYZ_usage.md @@ -13,7 +13,7 @@ There are 3 reference frames in this library. - 'geo': ['X', 'Y', 'Z', 'F'] -#### Magnetic of cylindrical #### +#### Magnetic or cylindrical #### - `mag` is HDZ @@ -42,7 +42,7 @@ March 2013 output to iaga2002 files: > and d,D. This mirrors the various data formats, (ie IAGA2002, etc). The underlying library provides calculations for both the basic conversions, -such as get_get_y_from_mag, which is based off of Y = H sin(D), and higher +such as get_geo_y_from_mag, which is based off of Y = H sin(D), and higher level conversions, such as get_geo_from_mag. (Which converts HD to XY). These are provided by `geomagio.ChannelConverter`. diff --git a/readme_develop_install.md b/readme_develop_install.md index e823d06758e2edf9227d021453ecafca0652a4c0..d787ec861fea21e64dda35180b02672cde0dfaf5 100644 --- a/readme_develop_install.md +++ b/readme_develop_install.md @@ -42,6 +42,20 @@ Begin Developing [Node]: http://nodejs.org/download/ +--- +### Coding Standards ### + +This project adheres to PEP8 standards in most cases: + https://www.python.org/dev/peps/pep-0008 + +### PEP8 Exceptions ### + +- Hanging/Visual indents (E126, E127, E128, E131) + + - line continuations should use two indentations (8 spaces). + - do not use visual indents. + + --- ### Add an SSH Key to GitHub ### @@ -65,3 +79,4 @@ Begin Developing 7. Click **Add SSH key**. Give it a meaningful title. 8. Copy your SSH Key into the Key, and click **Add key**. +