Merge pull request #97 from pysat/nrl_pub_release

NRL pub release
pysat · Feb 26, 2024 · 709ae58 · 709ae58
2 parents 819cbb2 + 48964fa
commit 709ae58
Show file tree

Hide file tree

Showing 26 changed files with 128 additions and 20 deletions.
diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md
@@ -0,0 +1,29 @@
+Funding
+=======
+The following institutions, missions, and programs have provided funding
+for pysatMadrigal 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
+
+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.
+
+Support and Thanks
+==================
+Thanks to Bill Rideout, who provided help when learning how to use the
+madrigalWeb package.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,7 @@ Change Log
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
-[0.1.X] - 2023-XX-XX
+[0.2.0] - 2024-XX-XX
 --------------------
 * Enhancements
   * Moved the OMNI-2 IMF, Dst, and Geomagnetic index Instruments from the

diff --git a/README.md b/README.md
@@ -47,7 +47,8 @@ a local install use the "--user" flag after "install".
 
 ```
 cd pysatMadrigal/
-python setup.py install
+python -m build .
+pip install .
 ```
 
 # Examples
@@ -67,7 +68,7 @@ Afterward, pysat will identify them using the `platform` and `name` keywords.
 
 ```
 pysat.utils.registry.register('pysatMadrigal.instruments.dmsp_ivm')
-dst = pysat.Instrument('dmsp', 'ivm', tag='utd', inst_id='f15')
+ivm = pysat.Instrument('dmsp', 'ivm', tag='utd', inst_id='f15')
 ```
 
 The package also include analysis tools.  Detailed examples are in the

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,6 +19,11 @@ data base as pysat.Instrument objects.
    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/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pysatMadrigal"
-version = "0.1.0"
+version = "0.2.0"
 description = 'Madrigal instrument support for the pysat ecosystem'
 readme = "README.md"
 requires-python = ">=3.6"

diff --git a/pysatMadrigal/instruments/dmsp_ivm.py b/pysatMadrigal/instruments/dmsp_ivm.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-
 """Supports the Defense Meteorological Satellite Program (DMSP) IVM instruments.
 
 The Ion Velocity Meter (IVM) is comprised of the Retarding Potential Analyzer
@@ -45,8 +48,6 @@
 ----
 Please provide name and email when downloading data with this routine.
 
-Code development supported by NSF grant 1259508
-
 """
 
 import datetime as dt

diff --git a/pysatMadrigal/instruments/dmsp_ssj.py b/pysatMadrigal/instruments/dmsp_ssj.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-
 """Support the DMSP Special Sensor-J (SSJ) instrument and derived products.
 
 The Defense Meteorological Satellite Program (DMSP) SSJ measures precipitating

diff --git a/pysatMadrigal/instruments/gnss_tec.py b/pysatMadrigal/instruments/gnss_tec.py
@@ -1,4 +1,12 @@
-# -*- coding: utf-8 -*-.
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Full license can be found in License.md
+# Full author list can be found in .zenodo.json file
+# DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Supports the MIT Haystack GNSS TEC data products.
 
 The Global Navigation Satellite System (GNSS) is used in conjunction with a

diff --git a/pysatMadrigal/instruments/jro_isr.py b/pysatMadrigal/instruments/jro_isr.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-.
 """Supports the Incoherent Scatter Radar at the Jicamarca Radio Observatory.
 
 Properties

diff --git a/pysatMadrigal/instruments/madrigal_dst.py b/pysatMadrigal/instruments/madrigal_dst.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-.
 """Supports access to Dst data archieved at Madrigal.
 
 Properties

diff --git a/pysatMadrigal/instruments/madrigal_geoind.py b/pysatMadrigal/instruments/madrigal_geoind.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-.
 """Supports access to F10.7, Kp, and Ap data archieved at Madrigal.
 
 Properties

diff --git a/pysatMadrigal/instruments/methods/dmsp.py b/pysatMadrigal/instruments/methods/dmsp.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-
 """Methods supporting the Defense Meteorological Satellite Program (DMSP)."""
 
 import numpy as np

diff --git a/pysatMadrigal/instruments/methods/general.py b/pysatMadrigal/instruments/methods/general.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-.
 """General routines for integrating CEDAR Madrigal instruments into pysat."""
 
 import datetime as dt

diff --git a/pysatMadrigal/instruments/methods/gnss.py b/pysatMadrigal/instruments/methods/gnss.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-
 """Methods supporting the Global Navigation Satellite System platform."""
 
 import datetime as dt

diff --git a/pysatMadrigal/instruments/methods/jro.py b/pysatMadrigal/instruments/methods/jro.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-
 """Methods supporting the Jicamarca Radio Observatory (JRO) platform."""
 
 import numpy as np

diff --git a/pysatMadrigal/instruments/ngdc_ae.py b/pysatMadrigal/instruments/ngdc_ae.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-.
 """Supports access to taped data of AE from the World Data Center A (Boulder).
 
 Properties

diff --git a/pysatMadrigal/instruments/omni2_imf.py b/pysatMadrigal/instruments/omni2_imf.py
@@ -1,9 +1,12 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-# -*- coding: utf-8 -*-.
 """Supports access to OMNI 2 IMF data archieved at Madrigal.
 
 Properties

diff --git a/pysatMadrigal/tests/test_instruments.py b/pysatMadrigal/tests/test_instruments.py
@@ -1,7 +1,11 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
 """Unit tests for the Instruments."""
 

diff --git a/pysatMadrigal/tests/test_methods_dmsp.py b/pysatMadrigal/tests/test_methods_dmsp.py
@@ -1,9 +1,13 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
-"""Test methods for `pysatMadrigal.instruments.methods.gnss`."""
+"""Test methods for `pysatMadrigal.instruments.methods.dmsp`."""
 
 import logging
 import numpy as np

diff --git a/pysatMadrigal/tests/test_methods_general.py b/pysatMadrigal/tests/test_methods_general.py
@@ -1,7 +1,11 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
 """Unit tests for the general instrument methods."""
 

diff --git a/pysatMadrigal/tests/test_methods_gnss.py b/pysatMadrigal/tests/test_methods_gnss.py
@@ -1,7 +1,11 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
 """Test methods for `pysatMadrigal.instruments.methods.gnss`."""
 

diff --git a/pysatMadrigal/tests/test_methods_jro.py b/pysatMadrigal/tests/test_methods_jro.py
@@ -1,7 +1,11 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
 """Test methods for `pysatMadrigal.instruments.methods.jro`."""
 

diff --git a/pysatMadrigal/tests/test_utils_coords.py b/pysatMadrigal/tests/test_utils_coords.py
@@ -1,3 +1,12 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+# Full license can be found in License.md
+# Full author list can be found in .zenodo.json file
+# DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Tests for the coordinate conversion functions."""
 import numpy as np
 

diff --git a/pysatMadrigal/utils/coords.py b/pysatMadrigal/utils/coords.py
@@ -1,7 +1,11 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 # Full license can be found in License.md
 # Full author list can be found in .zenodo.json file
 # DOI:10.5281/zenodo.3824979
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
 # ----------------------------------------------------------------------------
 """Coordinate transformation functions."""
 

diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = pysatMadrigal
-version = 0.1.0
+version = 0.2.0
 
 [flake8]
 max-line-length = 80