Merge pull request #158 from pysat/controlled_information

rstoneback · web-flow · commit 1d994ddd8609 · 2025-01-13T13:10:35.000-06:00
LGL: Update controlled information statement for accuracy and clarity
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
   * Fixed error in mock downloading F10.7 prelim files
   * Fixed combine_kp to consider desired time limits and fill values when
     loading the standard dataset
+  * Updated controlled information statement for clarity and accuracy
 
 [0.2.0] - 2024-08-30
 --------------------
diff --git a/docs/index.rst b/docs/index.rst
@@ -22,8 +22,10 @@ indices as pysat.Instrument objects.
    acknowledgements.rst
 
 
-.. admonition:: DISTRIBUTION STATEMENT A: Approved for public release.
-		Distribution is unlimited.
+.. admonition:: Review Status for Classified or Controlled Information by NRL
+
+   DISTRIBUTION STATEMENT A: Approved for public release.
+   Distribution is unlimited.
 
 
 
diff --git a/pysatSpaceWeather/instruments/ace_epam.py b/pysatSpaceWeather/instruments/ace_epam.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/ace_mag.py b/pysatSpaceWeather/instruments/ace_mag.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/ace_sis.py b/pysatSpaceWeather/instruments/ace_sis.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/ace_swepam.py b/pysatSpaceWeather/instruments/ace_swepam.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/ace.py b/pysatSpaceWeather/instruments/methods/ace.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/auroral_electrojet.py b/pysatSpaceWeather/instruments/methods/auroral_electrojet.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/dst.py b/pysatSpaceWeather/instruments/methods/dst.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/f107.py b/pysatSpaceWeather/instruments/methods/f107.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/general.py b/pysatSpaceWeather/instruments/methods/general.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/gfz.py b/pysatSpaceWeather/instruments/methods/gfz.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/kp_ap.py b/pysatSpaceWeather/instruments/methods/kp_ap.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/lasp.py b/pysatSpaceWeather/instruments/methods/lasp.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/lisird.py b/pysatSpaceWeather/instruments/methods/lisird.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/methods/swpc.py b/pysatSpaceWeather/instruments/methods/swpc.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_ae.py b/pysatSpaceWeather/instruments/sw_ae.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_al.py b/pysatSpaceWeather/instruments/sw_al.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_ap.py b/pysatSpaceWeather/instruments/sw_ap.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_apo.py b/pysatSpaceWeather/instruments/sw_apo.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_au.py b/pysatSpaceWeather/instruments/sw_au.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_cp.py b/pysatSpaceWeather/instruments/sw_cp.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_dst.py b/pysatSpaceWeather/instruments/sw_dst.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_f107.py b/pysatSpaceWeather/instruments/sw_f107.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_flare.py b/pysatSpaceWeather/instruments/sw_flare.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_hpo.py b/pysatSpaceWeather/instruments/sw_hpo.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_kp.py b/pysatSpaceWeather/instruments/sw_kp.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_mgii.py b/pysatSpaceWeather/instruments/sw_mgii.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_polarcap.py b/pysatSpaceWeather/instruments/sw_polarcap.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_sbfield.py b/pysatSpaceWeather/instruments/sw_sbfield.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_ssn.py b/pysatSpaceWeather/instruments/sw_ssn.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/instruments/sw_stormprob.py b/pysatSpaceWeather/instruments/sw_stormprob.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/tests/test_instruments.py b/pysatSpaceWeather/tests/test_instruments.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/tests/test_methods_ace.py b/pysatSpaceWeather/tests/test_methods_ace.py
@@ -3,6 +3,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/tests/test_methods_ae.py b/pysatSpaceWeather/tests/test_methods_ae.py
@@ -3,6 +3,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/tests/test_methods_f107.py b/pysatSpaceWeather/tests/test_methods_f107.py
@@ -3,6 +3,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/tests/test_methods_general.py b/pysatSpaceWeather/tests/test_methods_general.py
@@ -3,6 +3,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/tests/test_methods_gfz.py b/pysatSpaceWeather/tests/test_methods_gfz.py
@@ -3,6 +3,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/tests/test_methods_kp.py b/pysatSpaceWeather/tests/test_methods_kp.py
@@ -3,6 +3,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
diff --git a/pysatSpaceWeather/tests/test_methods_lisird.py b/pysatSpaceWeather/tests/test_methods_lisird.py
@@ -4,6 +4,8 @@
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3986138
 #
+# Review Status for Classified or Controlled Information by NRL
+# -------------------------------------------------------------
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`	`# Full author list can be found in .zenodo.json file`
`5`	`5`	`# DOI:10.5281/zenodo.3986138`
`6`	`6`	`#`
	`7`	`+# Review Status for Classified or Controlled Information by NRL`
	`8`	`+# -------------------------------------------------------------`
`7`	`9`	`# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is`
`8`	`10`	`# unlimited.`
`9`	`11`	`# ----------------------------------------------------------------------------`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`# Full author list can be found in .zenodo.json file`
`4`	`4`	`# DOI:10.5281/zenodo.3986138`
`5`	`5`	`#`
	`6`	`+# Review Status for Classified or Controlled Information by NRL`
	`7`	`+# -------------------------------------------------------------`
`6`	`8`	`# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is`
`7`	`9`	`# unlimited.`
`8`	`10`	`# ----------------------------------------------------------------------------`