Merge pull request #45 from pysat/nrl_pub_release

NRL pub release
pysat · Sep 23, 2024 · 5f72686 · 5f72686
2 parents 1420916 + df0670f
commit 5f72686
Show file tree

Hide file tree

Showing 14 changed files with 71 additions and 6 deletions.
diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md
@@ -11,20 +11,28 @@ Institutions
  - National Aeronautics and Space Administration (NASA)
  - National Oceanic and Atmospheric Administration (NOAA)
  - National Science Foundation (NSF)
+ - Office of Naval Research (ONR)
 
 Missions
 --------
- - NOAA Constellation Observing System for Meteorology Ionosphere and Climate (COSMIC-2)
+ - NOAA Constellation Observing System for Meteorology Ionosphere and Climate
+   (COSMIC-2)
  - NASA Ionospheric Connections Explorer (ICON)
- - NASA Scintillation Observations and Response of the Ionosphere to Electrodynamics (SORTIE)
+ - NASA Scintillation Observations and Response of the Ionosphere to
+   Electrodynamics (SORTIE)
  - NASA Scintillation Prediction Observations Research Task (SPORT)
 
 Programs
 --------
  - NSF 125908, AGS-1651393
  - NASA NNX10AT02G, NNH20ZDA001N-LWS, 80NSSC18K120, and 80NSSC21M0180
- - NASA Space Precipitation Impacts (SPI) project at Goddard Space Flight Center through the Heliophysics Internal Science Funding Model.
+ - NASA Space Precipitation Impacts (SPI) project at Goddard Space Flight
+   Center through the Heliophysics Internal Science Funding Model.
 
 Disclaimers
 ===========
-Any opinions or actions taken by the listed funding institutions are those of the institutions and do not necessarily reflect the views of the pysat development team or individual authors. 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.
+Any opinions or actions taken by the listed funding institutions are those of
+the institutions and do not necessarily reflect the views of the pysat
+development team or individual authors. 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/docs/acknowledgements.rst b/docs/acknowledgements.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../ACKNOWLEDGEMENTS.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,5 +1,11 @@
 # -*- coding: utf-8 -*-
-
+# Copyright (C) 2022, pysat development team
+# Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# -----------------------------------------------------------------------------
 """Configuration file for the Sphinx documentation builder.
 
 Note

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,4 @@
-.. pysatModels documentation main file.  Remember that it should at least
+.. pysatSeasons documentation main file.  Remember that it should at least
    contain the root `toctree` directive.
 
 Welcome to the pysatSeasons documentation
@@ -18,6 +18,11 @@ such as bin averaging, occurrence probabilities, and scatter plots.
    examples.rst
    develop_guide.rst
    history.rst
+   acknowledgements.rst
+
+
+.. admonition:: DISTRIBUTION STATEMENT A: Approved for public release.
+		Distribution is unlimited.
 
 
 Indices and tables

diff --git a/pysatSeasons/__init__.py b/pysatSeasons/__init__.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """pysatSeasons.
 

diff --git a/pysatSeasons/_core.py b/pysatSeasons/_core.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 import pandas as pds
 import xarray as xr

diff --git a/pysatSeasons/avg.py b/pysatSeasons/avg.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Instrument independent seasonal averaging routine.
 

diff --git a/pysatSeasons/occur_prob.py b/pysatSeasons/occur_prob.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Occurrence probability routines, daily or by orbit.
 

diff --git a/pysatSeasons/plot.py b/pysatSeasons/plot.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Support scatterplot production over seasons of interest."""
 

diff --git a/pysatSeasons/tests/__init__.py b/pysatSeasons/tests/__init__.py
@@ -1,3 +1,12 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Copyright (C) 2022, pysat development team
+# Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# -----------------------------------------------------------------------------
 """Unit and Integration Tests for pysatSeasons.
 
 Note

diff --git a/pysatSeasons/tests/test_avg.py b/pysatSeasons/tests/test_avg.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Test the pysat averaging code."""
 

diff --git a/pysatSeasons/tests/test_core.py b/pysatSeasons/tests/test_core.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Test the pysat _core code."""
 

diff --git a/pysatSeasons/tests/test_occur_prob.py b/pysatSeasons/tests/test_occur_prob.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Test pysatSeasons occur_prob object and code."""
 

diff --git a/pysatSeasons/tests/test_plot.py b/pysatSeasons/tests/test_plot.py
@@ -2,6 +2,10 @@
 # -*- coding: utf-8 -*-
 # Copyright (C) 2022, pysat development team
 # Full license can be found in License.md
+# DOI:10.5281/zenodo.3475493
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # -----------------------------------------------------------------------------
 """Test pysatSeasons plotting code."""