From 8d17773cc4d2ebc6f0b3c0adfd0bc635ebab4195 Mon Sep 17 00:00:00 2001
From: Jeremy Fee <jmfee@usgs.gov>
Date: Mon, 17 May 2021 12:27:13 -0600
Subject: [PATCH 1/4] Add initial elements documentation
---
docs/elements.md | 80 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 80 insertions(+)
create mode 100644 docs/elements.md
diff --git a/docs/elements.md b/docs/elements.md
new file mode 100644
index 000000000..96f5dff46
--- /dev/null
+++ b/docs/elements.md
@@ -0,0 +1,80 @@
+# Geomagnetic Elements
+
+
+
+## Obsrio
+Elements generated by observatories running the Obsrio data acquisition system.
+
+### Acquired elements
+
+- 10Hz volt + bin
+ - U, V, W
+
+- 1Hz engineering units
+ - F, T1-4
+
+### Derived variation
+
+- 1Hz engineering units
+
+ - U, V, W conversion from 10Hz volt+bin to 1Hz engineering units
+
+ uses instrument metadata from `geomagio.Metadata.get_instrument`
+
+- 1 minute engineering units
+
+ - T1-4
+
+ uses `geomagio.algorithm.FilterAlgorithm` to filter from 1Hz to 1 minute.
+
+
+## PCDCP
+Elements generated by observatories running the PCDCP data acquisition system.
+
+### Acquired elements
+
+- 1Hz legacy engineering units
+
+ - H, E, Z, F
+
+- 1 minute legacy engineering units
+
+### Derived variation
+
+- 1Hz engineering units
+
+ - U, V, W, F copied from legacy engineering units
+
+- 1 minute engineering units
+
+ - T1-4 copied from legacy engineering units
+
+
+## Common
+
+Derived elements calculated for all observatories.
+
+## Derived variation
+
+- 1Hz engineering units
+ - H, D, X, Y
+
+ uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from observatory (U,V) to magnetic (H,D) and geographic (X,Y).
+
+- 1 minute engineering units
+
+ - U, V, W, F, T1-4
+
+ uses `geomagio.algorithm.FilterAlgorithm` to filter from 1Hz to 1 minute.
+
+
+## Derived adjusted
+
+- 1Hz engineering units
+ - X, Y, Z, F
+
+ uses `geomagio.algorithm.AdjustedAlgorithm` with per-observatory matrices stored in filesystem.
+
+- 1 minute engineering units
+
+ uses `geomagio.algorithm.FilterAlgorithm` to filter from 1Hz to 1 minute.
--
GitLab
From 61cf0e2ba8e842894bc0fd8685b1c518222357ad Mon Sep 17 00:00:00 2001
From: pcain-usgs <pcain@usgs.gov>
Date: Tue, 25 May 2021 11:59:06 -0600
Subject: [PATCH 2/4] Document elements
---
docs/elements.md | 63 ++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 53 insertions(+), 10 deletions(-)
diff --git a/docs/elements.md b/docs/elements.md
index 96f5dff46..aacd05fb3 100644
--- a/docs/elements.md
+++ b/docs/elements.md
@@ -17,9 +17,11 @@ Elements generated by observatories running the Obsrio data acquisition system.
- 1Hz engineering units
- - U, V, W conversion from 10Hz volt+bin to 1Hz engineering units
+ - U, V, W
+
+ uses instrument metadata from `geomagio.Metadata.get_instrument` to convert volt+bin to engineering units.
- uses instrument metadata from `geomagio.Metadata.get_instrument`
+ uses `geomagio.algorithm.FilterAlgorithm` to filter from 10Hz to 1Hz.
- 1 minute engineering units
@@ -39,6 +41,8 @@ Elements generated by observatories running the PCDCP data acquisition system.
- 1 minute legacy engineering units
+ - T1-4
+
### Derived variation
- 1Hz engineering units
@@ -54,27 +58,66 @@ Elements generated by observatories running the PCDCP data acquisition system.
Derived elements calculated for all observatories.
-## Derived variation
+### Derived variation
- 1Hz engineering units
- - H, D, X, Y
+ - D, X, Y
- uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from observatory (U,V) to magnetic (H,D) and geographic (X,Y).
+ uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from observatory (U,V) to magnetic D and geographic (X,Y).
-- 1 minute engineering units
+ - G
+
+ uses `geomagio.algorithm.DeltaFAlgorithm` to generate delta F from U,V,W,F.
+
+- 1 minute/hour/day engineering units
- U, V, W, F, T1-4
- uses `geomagio.algorithm.FilterAlgorithm` to filter from 1Hz to 1 minute.
+ uses `geomagio.algorithm.FilterAlgorithm` to filter from 1Hz to 1 minute or 1 minute to 1 hour/day.
+
+ - D, X, Y
+
+ uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from observatory (U,V) to magnetic D and geographic (X,Y).
+
+ - G
+
+ uses `geomagio.algorithm.DeltaFAlgorithm` to generate delta F from U,V,W,F.
+
+ - H_SQ, H_SV, H_Dist
+ uses `geomagio.algorithm.SqDistAlgorithm` to produce solar quiet(SQ), secular variation(SV) and
+ magnetic disturbance(Dist) at 1 minute interval.
-## Derived adjusted
+### Derived adjusted
- 1Hz engineering units
- X, Y, Z, F
uses `geomagio.algorithm.AdjustedAlgorithm` with per-observatory matrices stored in filesystem.
-- 1 minute engineering units
+ - H, D
- uses `geomagio.algorithm.FilterAlgorithm` to filter from 1Hz to 1 minute.
+ uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from geographic (X,Y) to magnetic (H,D).
+
+ - G
+
+ uses `geomagio.algorithm.DeltaFAlgorithm` to generate delta F from X,Y,Z,F.
+
+- 1 minute/hour/day engineering units
+
+ - X, Y, Z, F
+
+ uses `geomagio.algorithm.FilterAlgorithm` to filter from 1Hz to 1 minute or 1 minute to 1 hour/day.
+
+ - H, D
+
+ uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from geographic (X,Y) to magnetic (H,D).
+
+ - G
+
+ uses `geomagio.algorithm.DeltaFAlgorithm` to generate delta F from X,Y,Z,F.
+
+ - H_SQ, H_SV, H_Dist
+
+ uses `geomagio.algorithm.SqDistAlgorithm` to produce solar quiet(SQ), secular variation(SV) and
+ magnetic disturbance(Dist) at 1 minute interval.
\ No newline at end of file
--
GitLab
From 4dabef1bb6ae0603ecbfb82a96744266a8863970 Mon Sep 17 00:00:00 2001
From: pcain-usgs <pcain@usgs.gov>
Date: Wed, 2 Jun 2021 13:57:41 -0600
Subject: [PATCH 3/4] add one minute HEZF/volts and 1Hz volts/bins to docs
---
docs/elements.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/docs/elements.md b/docs/elements.md
index aacd05fb3..3f1ce9cee 100644
--- a/docs/elements.md
+++ b/docs/elements.md
@@ -39,9 +39,16 @@ Elements generated by observatories running the PCDCP data acquisition system.
- H, E, Z, F
+ - 1Hz volt + bin
+ - LQA, LYB(H, E, Z volts/bins)
+
- 1 minute legacy engineering units
- T1-4
+ - H, E, Z, F
+
+ - 1 minute voltage
+ - UEB(battery voltage)
### Derived variation
--
GitLab
From 1ffa29201dd96af0b4519fd1c3260fd15935c35c Mon Sep 17 00:00:00 2001
From: pcain-usgs <pcain@usgs.gov>
Date: Fri, 4 Jun 2021 11:19:23 -0600
Subject: [PATCH 4/4] simplify pcdcp volt/bin, change magnetic H to obs D for
variation
---
docs/elements.md | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/docs/elements.md b/docs/elements.md
index 3f1ce9cee..d4340c308 100644
--- a/docs/elements.md
+++ b/docs/elements.md
@@ -39,16 +39,15 @@ Elements generated by observatories running the PCDCP data acquisition system.
- H, E, Z, F
- - 1Hz volt + bin
- - LQA, LYB(H, E, Z volts/bins)
+ - H, E, Z volt + bin
- 1 minute legacy engineering units
- T1-4
+
- H, E, Z, F
- - 1 minute voltage
- - UEB(battery voltage)
+ - instrument battery voltage
### Derived variation
@@ -70,7 +69,7 @@ Derived elements calculated for all observatories.
- 1Hz engineering units
- D, X, Y
- uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from observatory (U,V) to magnetic D and geographic (X,Y).
+ uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from observatory (U,V) to observatory D and geographic (X,Y).
- G
@@ -84,7 +83,7 @@ Derived elements calculated for all observatories.
- D, X, Y
- uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from observatory (U,V) to magnetic D and geographic (X,Y).
+ uses `geomagio.algorithm.XYZAlgorithm` to rotate coordinates from observatory (U,V) to observatory D and geographic (X,Y).
- G
--
GitLab