Element Documentation

Fixes #35 (closed)

Initial commit from !98 (closed)

Documents processing pipeline input/output elements

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