From f21ae2959a3a0530be3afea40b4f8cedfc3891d5 Mon Sep 17 00:00:00 2001 From: Eddie McWhirter <emcwhirter@usgs.gov> Date: Wed, 1 Jul 2015 13:36:31 -0600 Subject: [PATCH] Use continuation character for long lines of code. --- docs/README.md | 5 +++-- docs/XYZ.md | 15 +++++++++------ docs/XYZ_usage.md | 6 +++++- readme_usage.md | 16 ++++++++++++++-- 4 files changed, 31 insertions(+), 11 deletions(-) diff --git a/docs/README.md b/docs/README.md index c445b2db8..04a0eb163 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,10 +6,11 @@ Documents explaining geomag-algorithms [XYZ Algorithm](./XYZ.md) ------ -Describes the theory behind the XYZ algorithm, as well as some implementation issues and solutions. +Describes the theory behind the XYZ algorithm, as well as some implementation +issues and solutions. [Trace Metadata](./metadata.md) ----------- Describes the metadata stored in the obspy.core.trace.stats class used by the -geomag algorithms. +geomag algorithms. diff --git a/docs/XYZ.md b/docs/XYZ.md index 6d37ef5fe..5d79fe759 100644 --- a/docs/XYZ.md +++ b/docs/XYZ.md @@ -19,8 +19,10 @@ commercial entities. Inverse transformations are also provided. Historically, the most common coordinate system used to specify measured geomagnetic fields has been HDZ, where: -- `H` is the magnitude of the geomagnetic field vector tangential to the Earth's surface; -- `D` is the declination, or clockwise angle from the vector pointing to the geographic north pole to the H vector; +- `H` is the magnitude of the geomagnetic field vector tangential to the + Earth's surface; +- `D` is the declination, or clockwise angle from the vector pointing to the + geographic north pole to the H vector; - `Z` is the downward component of the geomagnetic field. > Note: this library internally refers to the `HDZ` coordinate system as "mag", @@ -88,9 +90,9 @@ One thing that is not labeled in this figure is the angle d (see [Eq. 4](#eq4)), which is the difference between declination D, and a declination baseline (D0, or DECBAS). -The equations [Eq. 4](#eq4), [Eq. 5](#eq5), [Eq. 6](#eq6) describe how to convert the -horizontal components of a USGS magnetometer's raw data element into more -standard H and D components. +The equations [Eq. 4](#eq4), [Eq. 5](#eq5), [Eq. 6](#eq6) describe how to +convert the horizontal components of a USGS magnetometer's raw data element +into more standard H and D components. - <a name="eq4"></a>Equation 4: `d = arctan(e/h)` - <a name="eq5"></a>Equation 5: `D = D0 + d` @@ -104,7 +106,8 @@ To inverse transform from `XY` to `HD`: ...and from `HD` to `he`: - <a name="eq9"></a>Equation 9: `d = D - D0` -- <a name="eq10"></a>Equation 10: `h = sqrt(H*H / (1 + tan(d)*tan(d))) = H cos(d)` +- <a name="eq10"></a>Equation 10: + `h = sqrt(H*H / (1 + tan(d)*tan(d))) = H cos(d)` - <a name="eq11"></a>Equation 11: `e = h * tan(d)` It is worth noting that there is potential for mathematically undefined results diff --git a/docs/XYZ_usage.md b/docs/XYZ_usage.md index aa0fd9187..765b0b2ab 100644 --- a/docs/XYZ_usage.md +++ b/docs/XYZ_usage.md @@ -31,7 +31,11 @@ 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 --- diff --git a/readme_usage.md b/readme_usage.md index 289dc7a99..7175e3e4c 100644 --- a/readme_usage.md +++ b/readme_usage.md @@ -29,14 +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 --- -- GitLab