Merge pull request #228 from pysat/nrl_pub_release

NRL pub release

.gitignore

@@ -56,6 +56,7 @@ coverage.xml
 
 # Sphinx documentation
 docs/_build/
+docs/.build/
 
 # PyBuilder
 target/

ACKNOWLEDGEMENTS.md

@@ -0,0 +1,29 @@
+Funding
+=======
+The following institutions, missions, and programs have provided funding
+for pysatNASA 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 Oceanic and Atmospheric Administration (NOAA)
+- National Science Foundation (NSF)
+- Office of Naval Research (ONR)
+
+Missions
+--------
+- NASA Ionospheric Connections Explorer (ICON)
+- NASA Scintillation Observations and Response of the Ionosphere to
+  Electrodynamics (SORTIE)
+- NASA Scintillation Prediction Observations Research Task (SPORT)
+
+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.

docs/acknowledgements.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../ACKNOWLEDGEMENTS.md

docs/archival.rst

@@ -1,22 +1,23 @@
 Building data files for archival at NASA SPDF
 =============================================
 
-The codes and routines at :py:mod:`pysatNASA` are designed for end-users of NASA data
-products. However, pysat in general has also been used to build operational
-instruments for generating archival data to be uploaded to the Space Physics
-Data Facility (SPDF) at NASA.
+The codes and routines at :py:mod:`pysatNASA` are designed for end-users of
+NASA data products. However, pysat in general has also been used to build
+operational instruments for generating archival data to be uploaded to the
+Space Physics Data Facility (SPDF) at NASA.
 
 In general, such instruments should include separate naming conventions. An
 example of this is the REACH data, where netCDF4 files are generated for
-archival purposes as part of the :py:mod:`ops_reach` package, but can be accessed by
-the end user through :py:mod:`pysatNASA`.
+archival purposes as part of the :py:mod:`ops_reach` package, but can be
+accessed by the end user through :py:mod:`pysatNASA`.
 
 In general, a :py:class:`pysat.Instrument` object can be constructed for any
 dataset. Full instructions and conventions can be found
-`here <https://pysat.readthedocs.io/en/latest/new_instrument.html>`_.  In the
-case of the REACH data, the operational code reads in a series of csv files and
-updates the metadata according to user specifications. Once the file is loaded,
-it can be exported to a netCDF4 file via pysat. In the simplest case, this is
+`at ReadTheDocs <https://pysat.readthedocs.io/en/latest/new_instrument.html>`_.
+In the case of the REACH data, the operational code reads in a series of CSV
+files and updates the metadata according to user specifications. Once the file
+is loaded, it can be exported to a netCDF4 file via pysat. In the simplest case,
+this is:
 
 ::
 
@@ -25,7 +26,7 @@ it can be exported to a netCDF4 file via pysat. In the simplest case, this is
 
 
 However, there are additional options when translating pysat metadata to SPDF
-preferred formats.  An example of this is
+preferred formats.  An example of this is:
 
 ::
 
@@ -54,11 +55,11 @@ metadata values required by the ITSP standards. Additionally, the
 internal :py:mod:`pysat` metadata values before writing to file.
 
 A full guide to SPDF metadata standards can be found 
-`here <https://spdf.gsfc.nasa.gov/istp_guide/istp_guide.html>`_.
+`at SPDF <https://spdf.gsfc.nasa.gov/istp_guide/istp_guide.html>`_.
 
-Other best practices for archival include adding the operational software version
-to the metadata header before writing. The pysat version will be automatically
-written to the metadata.
+Other best practices for archival include adding the operational software
+version to the metadata header before writing. The pysat version will be
+automatically written to the metadata.
 
 ::
 

docs/conf.py

@@ -174,7 +174,7 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {'<name>': ('https://docs.python.org/', None)}
 
 # Links to ignore, as they require human interaction
 linkcheck_ignore = [r'https://saber.gats-inc.com/temp_errors.php']

docs/index.rst

@@ -20,9 +20,14 @@ CDAWeb interface.
    develop_guide.rst
    archival.rst
    migration_guide.rst
+   acknowledgements.rst
    history.rst
 
 
+.. admonition:: DISTRIBUTION STATEMENT A: Approved for public release.
+		Distribution is unlimited.
+
+
 Indices and tables
 ==================
 

docs/supported_instruments.rst

@@ -97,7 +97,7 @@ DE2 VEFI
 .. automodule:: pysatNASA.instruments.de2_vefi
    :members:
 
-.. _de2_vefi:
+.. _de2_vefimag:
 
 DE2 VEFIMAGB
 ------------
@@ -207,7 +207,7 @@ MAVEN MAG
 MAVEN SEP
 ---------
 
-.. automodules:: pysatNASA.instruments.maven_sep
+.. automodule:: pysatNASA.instruments.maven_sep
    :members:
 
 .. _omni_hro:
@@ -221,7 +221,7 @@ OMNI HRO
 .. _reach_dosimeter:
 
 REACH DOSIMETER
-----------
+---------------
 
 .. automodule:: pysatNASA.instruments.reach_dosimeter
   :members:

pysatNASA/__init__.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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Core library for pysatNASA.
 
 This is a library of `pysat` instrument modules and methods designed to support

pysatNASA/constellations/__init__.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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Interface for pysatNASA to manage and analyze multiple pysat instruments.
 
 Each instrument is contained within a subpackage of the pysatNASA.instruments

pysatNASA/constellations/de2.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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Creates a constellation from the NASA DE2 satellite platform.
 
 Includes the core supported instruments.

pysatNASA/constellations/icon.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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Creates a constellation from NASA the ICON satellite platform.
 
 Includes the core instruments without the line of sight winds.

pysatNASA/instruments/__init__.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Collection of instruments for the pysatNASA library.
 
 Each instrument is contained within a subpackage of this set.

pysatNASA/instruments/ace_epam_l2.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the Advanced Composition Explorer (ACE) EPAM instrument.
 
 Properties

pysatNASA/instruments/ace_mag_l2.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the Advanced Composition Explorer (ACE) MAG instrument.
 
 Properties

pysatNASA/instruments/ace_sis_l2.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the Advanced Composition Explorer (ACE) SIS instrument.
 
 Properties

pysatNASA/instruments/ace_swepam_l2.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the Advanced Composition Explorer (ACE) EPAM instrument.
 
 Properties

pysatNASA/instruments/cnofs_ivm.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the C/NOFS IVM instrument.
 
 Supports the Ion Velocity Meter (IVM) onboard the Communication

pysatNASA/instruments/cnofs_plp.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the C/NOFS PLP instrument.
 
 Supports the Planar Langmuir Probe (PLP) onboard the Communication

pysatNASA/instruments/cnofs_vefi.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the C/NOFS VEFI instrument.
 
 Supports the Vector Electric Field Instrument (VEFI)

pysatNASA/instruments/de2_fpi.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """The DE2 FPI instrument.
 
 Supports the Fabry-Perot Interferometer (FPI) instrument on Dynamics Explorer 2

pysatNASA/instruments/de2_nacs.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """The DE2 NACS instrument.
 
 Supports the Neutral Atmosphere Composition Spectrometer (NACS) instrument

pysatNASA/instruments/de2_rpa.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the DE2 RPA instrument.
 
 Supports the Retarding Potential Analyzer (RPA) instrument on Dynamics

pysatNASA/instruments/de2_vefi.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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the DE2 VEFI instrument.
 
 .. deprecated:: 0.0.6

pysatNASA/instruments/de2_vefimagb.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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the DE2 VEFI instrument.
 
 From CDAWeb (adpated):

pysatNASA/instruments/de2_wats.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the DE2 WATS instrument.
 
 Supports the Wind and Temperature Spectrometer (WATS) instrument on

pysatNASA/instruments/dmsp_ssusi.py

@@ -1,4 +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.3986131
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Module for the DMSP SSUSI instrument.
 
 Supports the Special Sensor Ultraviolet Spectrographic Imager (SSUSI)