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
Admin message
Maintenance scheduled for Thursday, April 10, from 5 PM to 6 PM ET.
Show more breadcrumbs
ghsc
National Geomagnetism Program
geomag-algorithms
Commits
e368b8b5
Commit
e368b8b5
authored
9 years ago
by
Eddie McWhirter
Browse files
Options
Downloads
Patches
Plain Diff
Add XYZ usage.
parent
fdcadfb8
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
README.md
+9
-5
9 additions, 5 deletions
README.md
docs/XYZ_usage.md
+19
-0
19 additions, 0 deletions
docs/XYZ_usage.md
readme_usage.md
+7
-0
7 additions, 0 deletions
readme_usage.md
with
35 additions
and
5 deletions
README.md
+
9
−
5
View file @
e368b8b5
...
...
@@ -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)
...
...
This diff is collapsed.
Click to expand it.
docs/XYZ_usage.md
0 → 100644
+
19
−
0
View file @
e368b8b5
# 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)
This diff is collapsed.
Click to expand it.
readme_usage.md
+
7
−
0
View file @
e368b8b5
...
...
@@ -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
)
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