Merge pull request #138 from pysat/acknowledgements

ENH/DOC: Acknowledgements
pysat · Feb 1, 2024 · b7993bd · b7993bd
2 parents 080ecf4 + 2b5f7e1
commit b7993bd
Show file tree

Hide file tree

Showing 42 changed files with 28 additions and 54 deletions.
diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md
@@ -0,0 +1,25 @@
+Funding
+=======
+The following institutions, missions, and programs have provided funding
+for pysatSpaceWeather development.
+
+Institutions
+------------
+ - The Catholic University of America (CUA)
+ - Cosmic Studio
+ - Defense Advanced Research Projects Agency (DARPA) Defense Sciences Office
+ - National Aeronautics and Space Administration (NASA)
+ - National Science Foundation (NSF)
+ - Office of Naval Research (ONR)
+
+Programs
+--------
+ - NSF 125908, AGS-1651393
+ - Naval Research Laboratory N00173191G016 and N0017322P0744
+ - The Space Precipitation Impacts (SPI) project at Goddard Space Flight Center through the Heliophysics Internal Science Funding Model
+
+Disclaimers
+===========
+Any opinions, findings, and conclusions or recommendations expressed in this
+material are those of the author(s) and do not necessarily reflect the views
+of the funding agencies.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
   * Added new examples to the documentation
   * Added new test attributes for clean messages to the ACE instruments
   * Added the ability to 'download' files from a local directory
+  * Added an acknowledgements file with detailed funding information
 * Maintenance
   * Updated package documentation, yamls, and other supporting files
   * Updated the LISIRD download routine to reflect new behaviour

diff --git a/docs/acknowledgements.rst b/docs/acknowledgements.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../ACKNOWLEDGEMENTS.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,13 +19,12 @@ indices as pysat.Instrument objects.
    examples.rst
    develop_guide.rst
    history.rst
+   acknowledgements.rst
 
 
 .. admonition:: DISTRIBUTION STATEMENT A: Approved for public release.
 		Distribution is unlimited.
 
-    This work was supported by the Office of Naval Research.
-
 
 
 Indices and tables

diff --git a/pysatSpaceWeather/instruments/ace_epam.py b/pysatSpaceWeather/instruments/ace_epam.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports ACE Electron, Proton, and Alpha Monitor data.
 

diff --git a/pysatSpaceWeather/instruments/ace_mag.py b/pysatSpaceWeather/instruments/ace_mag.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports ACE Magnetometer data.
 

diff --git a/pysatSpaceWeather/instruments/ace_sis.py b/pysatSpaceWeather/instruments/ace_sis.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports ACE Solar Isotope Spectrometer data.
 

diff --git a/pysatSpaceWeather/instruments/ace_swepam.py b/pysatSpaceWeather/instruments/ace_swepam.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports ACE Solar Wind Electron Proton Alpha Monitor data.
 

diff --git a/pysatSpaceWeather/instruments/methods/ace.py b/pysatSpaceWeather/instruments/methods/ace.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides general routines for the ACE space weather instruments."""
 

diff --git a/pysatSpaceWeather/instruments/methods/auroral_electrojet.py b/pysatSpaceWeather/instruments/methods/auroral_electrojet.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides support routines for auroral electrojet indices."""
 

diff --git a/pysatSpaceWeather/instruments/methods/dst.py b/pysatSpaceWeather/instruments/methods/dst.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides default routines for Dst."""
 

diff --git a/pysatSpaceWeather/instruments/methods/f107.py b/pysatSpaceWeather/instruments/methods/f107.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 
 """Routines for the F10.7 solar index."""

diff --git a/pysatSpaceWeather/instruments/methods/general.py b/pysatSpaceWeather/instruments/methods/general.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides routines that support general space weather instruments."""
 

diff --git a/pysatSpaceWeather/instruments/methods/gfz.py b/pysatSpaceWeather/instruments/methods/gfz.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides routines that support GFZ space weather instruments."""
 

diff --git a/pysatSpaceWeather/instruments/methods/kp_ap.py b/pysatSpaceWeather/instruments/methods/kp_ap.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides routines to support the geomagnetic indices, Kp and Ap."""
 

diff --git a/pysatSpaceWeather/instruments/methods/lasp.py b/pysatSpaceWeather/instruments/methods/lasp.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides support routines for LASP data."""
 

diff --git a/pysatSpaceWeather/instruments/methods/lisird.py b/pysatSpaceWeather/instruments/methods/lisird.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides support functions for the LASP LISIRD data base."""
 

diff --git a/pysatSpaceWeather/instruments/methods/swpc.py b/pysatSpaceWeather/instruments/methods/swpc.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Provides routines that support SWPC space weather instruments."""
 

diff --git a/pysatSpaceWeather/instruments/sw_ae.py b/pysatSpaceWeather/instruments/sw_ae.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports the auroral electrojet AE values.
 

diff --git a/pysatSpaceWeather/instruments/sw_al.py b/pysatSpaceWeather/instruments/sw_al.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports the auroral electrojet AL values.
 

diff --git a/pysatSpaceWeather/instruments/sw_ap.py b/pysatSpaceWeather/instruments/sw_ap.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports ap index values.
 

diff --git a/pysatSpaceWeather/instruments/sw_apo.py b/pysatSpaceWeather/instruments/sw_apo.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports apo index values.
 

diff --git a/pysatSpaceWeather/instruments/sw_au.py b/pysatSpaceWeather/instruments/sw_au.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports the auroral electrojet AU values.
 

diff --git a/pysatSpaceWeather/instruments/sw_cp.py b/pysatSpaceWeather/instruments/sw_cp.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports Cp index values.
 

diff --git a/pysatSpaceWeather/instruments/sw_dst.py b/pysatSpaceWeather/instruments/sw_dst.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports Dst values. Downloads data from NGDC.
 
@@ -26,13 +25,6 @@
 ----
 Will only work until 2057.
 
-This material is based upon work supported by the
-National Science Foundation under Grant Number 1259508.
-
-Any opinions, findings, and conclusions or recommendations expressed in this
-material are those of the author(s) and do not necessarily reflect the views
-of the National Science Foundation.
-
 """
 
 import datetime as dt

diff --git a/pysatSpaceWeather/instruments/sw_f107.py b/pysatSpaceWeather/instruments/sw_f107.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports F10.7 index values.
 

diff --git a/pysatSpaceWeather/instruments/sw_flare.py b/pysatSpaceWeather/instruments/sw_flare.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports solar flare values.
 

diff --git a/pysatSpaceWeather/instruments/sw_hpo.py b/pysatSpaceWeather/instruments/sw_hpo.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports Hpo index values.
 

diff --git a/pysatSpaceWeather/instruments/sw_kp.py b/pysatSpaceWeather/instruments/sw_kp.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports Kp index values.
 
@@ -65,13 +64,6 @@
 feature, and multi_file_day feature available from the pyast.Instrument object
 is not appropriate for these tags data.
 
-This material is based upon work supported by the
-National Science Foundation under Grant Number 1259508.
-
-Any opinions, findings, and conclusions or recommendations expressed in this
-material are those of the author(s) and do not necessarily reflect the views
-of the National Science Foundation.
-
 """
 
 import datetime as dt

diff --git a/pysatSpaceWeather/instruments/sw_mgii.py b/pysatSpaceWeather/instruments/sw_mgii.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports the MgII core-to-wing ratio index.
 

diff --git a/pysatSpaceWeather/instruments/sw_polarcap.py b/pysatSpaceWeather/instruments/sw_polarcap.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports polar cap indexes.
 

diff --git a/pysatSpaceWeather/instruments/sw_sbfield.py b/pysatSpaceWeather/instruments/sw_sbfield.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports solar magnetic field values.
 

diff --git a/pysatSpaceWeather/instruments/sw_ssn.py b/pysatSpaceWeather/instruments/sw_ssn.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports Sunspot Number (SSN) and related indices.
 

diff --git a/pysatSpaceWeather/instruments/sw_stormprob.py b/pysatSpaceWeather/instruments/sw_stormprob.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Supports storm probabilities.
 

diff --git a/pysatSpaceWeather/tests/test_instruments.py b/pysatSpaceWeather/tests/test_instruments.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Unit and Integration Tests for each instrument module.
 

diff --git a/pysatSpaceWeather/tests/test_methods_ace.py b/pysatSpaceWeather/tests/test_methods_ace.py
@@ -5,7 +5,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Integration and unit test suite for ACE methods."""
 

diff --git a/pysatSpaceWeather/tests/test_methods_ae.py b/pysatSpaceWeather/tests/test_methods_ae.py
@@ -5,7 +5,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Integration and unit test suite for AE methods."""
 

diff --git a/pysatSpaceWeather/tests/test_methods_f107.py b/pysatSpaceWeather/tests/test_methods_f107.py
@@ -5,7 +5,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Test suite for F10.7 methods."""
 

diff --git a/pysatSpaceWeather/tests/test_methods_general.py b/pysatSpaceWeather/tests/test_methods_general.py
@@ -5,7 +5,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Integration and unit test suite for ACE methods."""
 

diff --git a/pysatSpaceWeather/tests/test_methods_gfz.py b/pysatSpaceWeather/tests/test_methods_gfz.py
@@ -5,7 +5,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Integration and unit test suite for ACE methods."""
 

diff --git a/pysatSpaceWeather/tests/test_methods_kp.py b/pysatSpaceWeather/tests/test_methods_kp.py
@@ -5,7 +5,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Test suite for Kp and Ap methods."""
 

diff --git a/pysatSpaceWeather/tests/test_methods_lisird.py b/pysatSpaceWeather/tests/test_methods_lisird.py
@@ -6,7 +6,6 @@
 #
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
-# This work was supported by the Office of Naval Research.
 # ----------------------------------------------------------------------------
 """Tests for the LISIRD functions."""