Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
G
geomag-algorithms
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ghsc
National Geomagnetism Program
geomag-algorithms
Commits
98caa627
Commit
98caa627
authored
9 years ago
by
Eddie McWhirter
Browse files
Options
Downloads
Patches
Plain Diff
Highlight parameters in usage readme.
parent
bf49e7a7
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/usage.md
+18
-11
18 additions, 11 deletions
docs/usage.md
with
18 additions
and
11 deletions
docs/usage.md
+
18
−
11
View file @
98caa627
...
@@ -25,10 +25,10 @@ examples. They include
...
@@ -25,10 +25,10 @@ examples. They include
### Examples ###
### Examples ###
To retrieve all
_
raw
_
(variation
) _H_, _E_,
_Z_ and _F_
_minute_ data from
To retrieve all raw (
**_
variation
_**
)
**_H_**
,
**_E_**
,
**
_Z_
**
and
**
_F_
**
_
Boulder Observatory
_
for the entire day of
_July 1st 2014_ from an _iaga2002_
**_minute_**
data from
Boulder Observatory
(
**_BOU_**
)
for the entire day of
formatted file and output _H_, _E_, _Z_ and _F_ data to a _PCDCP_ formatted
**_July 1st 2014_**
from an
**_iaga2002_**
formatted file and output
file:
**_H_**
,
**_E_**
,
**_Z_**
and
**_F_**
data to a
**_pcdcp_**
formatted
file:
geomag.py --type variation --inchannels H E Z F --interval minute \
geomag.py --type variation --inchannels H E Z F --interval minute \
--observatory BOU \
--observatory BOU \
...
@@ -38,10 +38,11 @@ file:
...
@@ -38,10 +38,11 @@ file:
--outchannels H E Z F \
--outchannels H E Z F \
--output-pcdcp-file BOU2014182.min
--output-pcdcp-file BOU2014182.min
To retrieve all _raw_ (variation) _H_, _E_, _Z_ and _F_ _minute_ data from
To retrieve all raw (
**_variation_**
)
**_H_**
,
**_E_**
,
**_Z_**
and
**_F_**
_Tucson Observatory_
for the entire month of _March 2013_ from _pcdcp_
**_minute_**
data from Tucson Observatory (
**_TUC_**
) for the entire month of
formatted files in a "data-pcdcp" directory and output _H_, _E_, _Z_ and _F_
**_March 2013_**
from a group of
**_pcdcp_**
formatted files in a "data-pcdcp"
data to a group of _iaga2002_ formatted files in a "data-iaga" directory:
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 \
geomag.py --type variation --inchannels H E Z F --interval minute \
--observatory TUC \
--observatory TUC \
...
@@ -51,9 +52,10 @@ data to a group of _iaga2002_ formatted files in a "data-iaga" directory:
...
@@ -51,9 +52,10 @@ data to a group of _iaga2002_ formatted files in a "data-iaga" directory:
--output-iaga-url file://data-iaga/./$(obs)s%(Y)s%(j)s.%(i)s \
--output-iaga-url file://data-iaga/./$(obs)s%(Y)s%(j)s.%(i)s \
--outchannels H E Z F
--outchannels H E Z F
To retrieve all _Dst 4 minute_, and _Dst3 minute_ data from _USGS_ for the
To retrieve all
**_Dst 4 minute_**
, and
**_Dst 3 minute_**
data from
**_USGS_**
entire day of _Oct 1st 2015_ from _edge server cwbpub.cr.usgs.gov_ output
for the entire day of
**_Oct 1st 2015_**
from an
**_edge server_**
(at
_Dst 4 minute_
, and _Dst 3 minute_ data to an _iaga2002_ formatted file:
cwbpub.cr.usgs.gov) and output
**_Dst 4 minute_**
, and
**_Dst 3 minute_**
data to an
**_iaga2002_**
formatted file:
geomag.py --type variation --inchannels MGD MSD --interval minute \
geomag.py --type variation --inchannels MGD MSD --interval minute \
--observatory USGS \
--observatory USGS \
...
@@ -72,11 +74,16 @@ There are flags to specify certain algorithms should be run against the data.
...
@@ -72,11 +74,16 @@ There are flags to specify certain algorithms should be run against the data.
#### XYZ ####
#### XYZ ####
`--algorithm xyz`
`--algorithm xyz`
`--xyz-from {geo, mag, obs, obsd}`
(default is
`obs`
)
`--xyz-from {geo, mag, obs, obsd}`
(default is
`obs`
)
`--xyz-to {geo, mag, obs, obsd}`
(default is
`geo`
)
`--xyz-to {geo, mag, obs, obsd}`
(default is
`geo`
)
#### [XYZ Usage](./algorithms/XYZ_usage.md) ####
#### [XYZ Usage](./algorithms/XYZ_usage.md) ####
Rotate data from HEZ (obs) or HDZ (mag) to XYZ (geo) and back.
Rotate data from HEZ (obs) or HDZ (mag) to XYZ (geo) and back.
Document:
[
/algorithms/XYZ_usage.md
](
./algorithms/XYZ_usage.md
)
Extensive explanation of all input and output methods:
Extensive explanation of all input and output methods:
[
IO Methods
](
./io.md
)
[
IO Methods
](
./io.md
)
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment