From 8b5e54153c78e59a4c9127aaa3ad89469adbfc41 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 11:22:52 -0400 Subject: [PATCH 01/15] DOC: added acknowledgements Added acknowledgements documentation to the repository and documentation. --- ACKNOWLEDGEMENTS.md | 33 +++++++++++++++++++++++++++++++++ docs/acknowledgements.rst | 1 + docs/index.rst | 1 + 3 files changed, 35 insertions(+) create mode 100644 ACKNOWLEDGEMENTS.md create mode 100644 docs/acknowledgements.rst diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md new file mode 100644 index 00000000..182d6e6c --- /dev/null +++ b/ACKNOWLEDGEMENTS.md @@ -0,0 +1,33 @@ +Funding +======= +The following institutions, missions, and programs have provided funding +for pysatNASA development. + +Institutions +------------ +- Alphabetical list of institutions + +Missions +-------- +- 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) + +Programs +-------- +- 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. diff --git a/docs/acknowledgements.rst b/docs/acknowledgements.rst new file mode 100644 index 00000000..dd1f917a --- /dev/null +++ b/docs/acknowledgements.rst @@ -0,0 +1 @@ +.. mdinclude:: ../ACKNOWLEDGEMENTS.md diff --git a/docs/index.rst b/docs/index.rst index a2b0ca12..f071c006 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ CDAWeb interface. develop_guide.rst archival.rst migration_guide.rst + acnkowledgements.rst history.rst From 3f9f8bcc3968de5df5ec863db5a7163a3f8b7b34 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:12:32 -0400 Subject: [PATCH 02/15] DOC: added pub release to docs Added the NRL pub release statement to the documentation. --- docs/index.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index f071c006..65122f8d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,6 +24,10 @@ CDAWeb interface. history.rst +.. admonition:: DISTRIBUTION STATEMENT A: Approved for public release. + Distribution is unlimited. + + Indices and tables ================== From ce0d57e201bb2b4668991d7185eb2f33616d2bad Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:13:06 -0400 Subject: [PATCH 03/15] DOC: top level pub release Added the NRL pub release statement to the top level code files. --- pysatNASA/__init__.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/pysatNASA/__init__.py b/pysatNASA/__init__.py index 650c6162..3fbbb608 100644 --- a/pysatNASA/__init__.py +++ b/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 From c8bfc98d64744d186c33b0c41047361db93a1023 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:13:26 -0400 Subject: [PATCH 04/15] DOC: constellation pub release Added the NRL pub release statement to the constellation files. --- pysatNASA/constellations/__init__.py | 9 +++++++++ pysatNASA/constellations/de2.py | 9 +++++++++ pysatNASA/constellations/icon.py | 9 +++++++++ 3 files changed, 27 insertions(+) diff --git a/pysatNASA/constellations/__init__.py b/pysatNASA/constellations/__init__.py index 2502aa37..bcfbc846 100644 --- a/pysatNASA/constellations/__init__.py +++ b/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 diff --git a/pysatNASA/constellations/de2.py b/pysatNASA/constellations/de2.py index 2a5ad572..f5a80ef8 100644 --- a/pysatNASA/constellations/de2.py +++ b/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. diff --git a/pysatNASA/constellations/icon.py b/pysatNASA/constellations/icon.py index 42cd6462..e7cd4d88 100644 --- a/pysatNASA/constellations/icon.py +++ b/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. From 6d6086fc40f4030def675d33df94c06fec5a6436 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:14:38 -0400 Subject: [PATCH 05/15] DOC: updated instrument with pub release Added the NRL pub release to the instrument sub-module files. --- pysatNASA/instruments/__init__.py | 8 ++++++++ pysatNASA/instruments/ace_epam_l2.py | 8 ++++++++ pysatNASA/instruments/ace_mag_l2.py | 8 ++++++++ pysatNASA/instruments/ace_sis_l2.py | 8 ++++++++ pysatNASA/instruments/ace_swepam_l2.py | 8 ++++++++ pysatNASA/instruments/cnofs_ivm.py | 8 ++++++++ pysatNASA/instruments/cnofs_plp.py | 8 ++++++++ pysatNASA/instruments/cnofs_vefi.py | 8 ++++++++ pysatNASA/instruments/de2_fpi.py | 8 ++++++++ pysatNASA/instruments/de2_nacs.py | 8 ++++++++ pysatNASA/instruments/de2_rpa.py | 8 ++++++++ pysatNASA/instruments/de2_vefi.py | 9 +++++++++ pysatNASA/instruments/de2_vefimagb.py | 9 +++++++++ pysatNASA/instruments/de2_wats.py | 8 ++++++++ pysatNASA/instruments/dmsp_ssusi.py | 8 ++++++++ pysatNASA/instruments/formosat1_ivm.py | 8 ++++++++ pysatNASA/instruments/icon_euv.py | 8 ++++++++ pysatNASA/instruments/icon_fuv.py | 8 ++++++++ pysatNASA/instruments/icon_ivm.py | 8 ++++++++ pysatNASA/instruments/icon_mighti.py | 8 ++++++++ pysatNASA/instruments/igs_gps.py | 8 ++++++++ pysatNASA/instruments/iss_fpmu.py | 8 ++++++++ pysatNASA/instruments/jpl_gps.py | 8 ++++++++ pysatNASA/instruments/maven_insitu_kp.py | 8 ++++++++ pysatNASA/instruments/maven_mag.py | 8 ++++++++ pysatNASA/instruments/maven_sep.py | 8 ++++++++ pysatNASA/instruments/omni_hro.py | 8 ++++++++ pysatNASA/instruments/reach_dosimeter.py | 8 ++++++++ pysatNASA/instruments/ses14_gold.py | 9 +++++++++ pysatNASA/instruments/timed_guvi.py | 8 ++++++++ pysatNASA/instruments/timed_saber.py | 8 ++++++++ pysatNASA/instruments/timed_see.py | 8 ++++++++ 32 files changed, 259 insertions(+) diff --git a/pysatNASA/instruments/__init__.py b/pysatNASA/instruments/__init__.py index 5679a35a..336c6fc4 100644 --- a/pysatNASA/instruments/__init__.py +++ b/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. diff --git a/pysatNASA/instruments/ace_epam_l2.py b/pysatNASA/instruments/ace_epam_l2.py index 61dddf8e..a60bf8f4 100644 --- a/pysatNASA/instruments/ace_epam_l2.py +++ b/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 diff --git a/pysatNASA/instruments/ace_mag_l2.py b/pysatNASA/instruments/ace_mag_l2.py index dfe26153..4ff8a15c 100644 --- a/pysatNASA/instruments/ace_mag_l2.py +++ b/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 diff --git a/pysatNASA/instruments/ace_sis_l2.py b/pysatNASA/instruments/ace_sis_l2.py index 188f5973..04f7310e 100644 --- a/pysatNASA/instruments/ace_sis_l2.py +++ b/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 diff --git a/pysatNASA/instruments/ace_swepam_l2.py b/pysatNASA/instruments/ace_swepam_l2.py index b16b37ed..63019edb 100644 --- a/pysatNASA/instruments/ace_swepam_l2.py +++ b/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 diff --git a/pysatNASA/instruments/cnofs_ivm.py b/pysatNASA/instruments/cnofs_ivm.py index 59dbf57b..2a583e2b 100644 --- a/pysatNASA/instruments/cnofs_ivm.py +++ b/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 diff --git a/pysatNASA/instruments/cnofs_plp.py b/pysatNASA/instruments/cnofs_plp.py index 549ad42b..c1909e4b 100644 --- a/pysatNASA/instruments/cnofs_plp.py +++ b/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 diff --git a/pysatNASA/instruments/cnofs_vefi.py b/pysatNASA/instruments/cnofs_vefi.py index 334b7565..80bfc905 100644 --- a/pysatNASA/instruments/cnofs_vefi.py +++ b/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) diff --git a/pysatNASA/instruments/de2_fpi.py b/pysatNASA/instruments/de2_fpi.py index d27693ed..185c5a6f 100644 --- a/pysatNASA/instruments/de2_fpi.py +++ b/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 diff --git a/pysatNASA/instruments/de2_nacs.py b/pysatNASA/instruments/de2_nacs.py index ba949e95..d1204fe1 100644 --- a/pysatNASA/instruments/de2_nacs.py +++ b/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 diff --git a/pysatNASA/instruments/de2_rpa.py b/pysatNASA/instruments/de2_rpa.py index aa97b66d..958df9b2 100644 --- a/pysatNASA/instruments/de2_rpa.py +++ b/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 diff --git a/pysatNASA/instruments/de2_vefi.py b/pysatNASA/instruments/de2_vefi.py index 68a7c178..28f13a15 100644 --- a/pysatNASA/instruments/de2_vefi.py +++ b/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 diff --git a/pysatNASA/instruments/de2_vefimagb.py b/pysatNASA/instruments/de2_vefimagb.py index 0b9f08d7..83ec6432 100644 --- a/pysatNASA/instruments/de2_vefimagb.py +++ b/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): diff --git a/pysatNASA/instruments/de2_wats.py b/pysatNASA/instruments/de2_wats.py index 5a784d24..e392a40a 100644 --- a/pysatNASA/instruments/de2_wats.py +++ b/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 diff --git a/pysatNASA/instruments/dmsp_ssusi.py b/pysatNASA/instruments/dmsp_ssusi.py index 0b4a892c..eff48b20 100644 --- a/pysatNASA/instruments/dmsp_ssusi.py +++ b/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) diff --git a/pysatNASA/instruments/formosat1_ivm.py b/pysatNASA/instruments/formosat1_ivm.py index ceccc95c..39d6e5a7 100644 --- a/pysatNASA/instruments/formosat1_ivm.py +++ b/pysatNASA/instruments/formosat1_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 Formosat-1 IVM instrument. Supports the Ion Velocity Meter (IVM) onboard the Formosat-1 (formerly diff --git a/pysatNASA/instruments/icon_euv.py b/pysatNASA/instruments/icon_euv.py index 499f2b31..66b09f48 100644 --- a/pysatNASA/instruments/icon_euv.py +++ b/pysatNASA/instruments/icon_euv.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 ICON EUV instrument. Supports the Extreme Ultraviolet (EUV) imager onboard the Ionospheric diff --git a/pysatNASA/instruments/icon_fuv.py b/pysatNASA/instruments/icon_fuv.py index 94c283fb..f083c344 100644 --- a/pysatNASA/instruments/icon_fuv.py +++ b/pysatNASA/instruments/icon_fuv.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 ICON FUV instrument. Supports the Far Ultraviolet (FUV) imager onboard the Ionospheric diff --git a/pysatNASA/instruments/icon_ivm.py b/pysatNASA/instruments/icon_ivm.py index 29206cd6..8de94440 100644 --- a/pysatNASA/instruments/icon_ivm.py +++ b/pysatNASA/instruments/icon_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 ICON IVM instrument. Supports the Ion Velocity Meter (IVM) onboard the Ionospheric Connections diff --git a/pysatNASA/instruments/icon_mighti.py b/pysatNASA/instruments/icon_mighti.py index a108e8d2..52ed6883 100644 --- a/pysatNASA/instruments/icon_mighti.py +++ b/pysatNASA/instruments/icon_mighti.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 ICON MIGHTI instrument. Supports the Michelson Interferometer for Global High-resolution diff --git a/pysatNASA/instruments/igs_gps.py b/pysatNASA/instruments/igs_gps.py index 99cd4690..a005df7c 100644 --- a/pysatNASA/instruments/igs_gps.py +++ b/pysatNASA/instruments/igs_gps.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 IGS GPS data products. Supports GPS data produced from International GNSS Service Total Electron diff --git a/pysatNASA/instruments/iss_fpmu.py b/pysatNASA/instruments/iss_fpmu.py index d65272e3..e5a8987e 100644 --- a/pysatNASA/instruments/iss_fpmu.py +++ b/pysatNASA/instruments/iss_fpmu.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 ISS FPMU instrument. Supports the Floating Potential Measurement Unit diff --git a/pysatNASA/instruments/jpl_gps.py b/pysatNASA/instruments/jpl_gps.py index 040ceac0..067ad625 100644 --- a/pysatNASA/instruments/jpl_gps.py +++ b/pysatNASA/instruments/jpl_gps.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 JPL GPS data products. .. deprecated:: 0.0.5 diff --git a/pysatNASA/instruments/maven_insitu_kp.py b/pysatNASA/instruments/maven_insitu_kp.py index 7210b7e5..d8239e73 100644 --- a/pysatNASA/instruments/maven_insitu_kp.py +++ b/pysatNASA/instruments/maven_insitu_kp.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 MAVEN insitu instruments. Supports the in situ Key Parameter (kp) data from multiple instruments diff --git a/pysatNASA/instruments/maven_mag.py b/pysatNASA/instruments/maven_mag.py index c1125bd7..738d1fed 100644 --- a/pysatNASA/instruments/maven_mag.py +++ b/pysatNASA/instruments/maven_mag.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 MAVEN mag instrument. Supports the Magnetometer (MAG) onboard the Mars Atmosphere diff --git a/pysatNASA/instruments/maven_sep.py b/pysatNASA/instruments/maven_sep.py index b1fe80b2..bc2e94b6 100644 --- a/pysatNASA/instruments/maven_sep.py +++ b/pysatNASA/instruments/maven_sep.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 MAVEN sep instrument. Supports the Solar Energetic Particle (SEP) data from diff --git a/pysatNASA/instruments/omni_hro.py b/pysatNASA/instruments/omni_hro.py index b37f2954..d5bcd93f 100644 --- a/pysatNASA/instruments/omni_hro.py +++ b/pysatNASA/instruments/omni_hro.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 OMNI HRO instrument. Supports OMNI Combined, Definitive, IMF and Plasma Data, and Energetic diff --git a/pysatNASA/instruments/reach_dosimeter.py b/pysatNASA/instruments/reach_dosimeter.py index c7cebdcb..d56cc0c5 100644 --- a/pysatNASA/instruments/reach_dosimeter.py +++ b/pysatNASA/instruments/reach_dosimeter.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 REACH dosimeter instrument. Supports the dosimeter instrument on the Responsive Environmental Assessment diff --git a/pysatNASA/instruments/ses14_gold.py b/pysatNASA/instruments/ses14_gold.py index d0c7567d..61bb8caa 100644 --- a/pysatNASA/instruments/ses14_gold.py +++ b/pysatNASA/instruments/ses14_gold.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 SES14 GOLD instrument. Supports the Nmax data product from the Global Observations of the Limb and diff --git a/pysatNASA/instruments/timed_guvi.py b/pysatNASA/instruments/timed_guvi.py index 6087ce6e..f153b93c 100644 --- a/pysatNASA/instruments/timed_guvi.py +++ b/pysatNASA/instruments/timed_guvi.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 TIMED GUVI instrument. Supports the Global UltraViolet Imager (GUVI) instrument on the Thermosphere diff --git a/pysatNASA/instruments/timed_saber.py b/pysatNASA/instruments/timed_saber.py index 5859dbfa..b70e2577 100644 --- a/pysatNASA/instruments/timed_saber.py +++ b/pysatNASA/instruments/timed_saber.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 TIMED SABER instrument. Supports the Sounding of the Atmosphere using Broadband Emission Radiometry diff --git a/pysatNASA/instruments/timed_see.py b/pysatNASA/instruments/timed_see.py index ef24b1ef..8fb50e87 100644 --- a/pysatNASA/instruments/timed_see.py +++ b/pysatNASA/instruments/timed_see.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. +# ---------------------------------------------------------------------------- """Supports the SEE instrument on TIMED. Downloads data from the NASA Coordinated Data From 17176b051716be7d7d8297ad7603bd37347f2b0c Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:28:05 -0400 Subject: [PATCH 06/15] DOC: updated instrument methods headers Added NRL pub release to the instrument method sub-modules. --- pysatNASA/instruments/methods/__init__.py | 9 +++++++++ pysatNASA/instruments/methods/_cdf.py | 8 ++++++++ pysatNASA/instruments/methods/ace.py | 8 ++++++++ pysatNASA/instruments/methods/cdaweb.py | 8 ++++++++ pysatNASA/instruments/methods/cnofs.py | 8 ++++++++ pysatNASA/instruments/methods/de2.py | 8 ++++++++ pysatNASA/instruments/methods/dmsp.py | 8 ++++++++ pysatNASA/instruments/methods/formosat.py | 8 ++++++++ pysatNASA/instruments/methods/general.py | 9 +++++++++ pysatNASA/instruments/methods/gps.py | 8 ++++++++ pysatNASA/instruments/methods/icon.py | 8 ++++++++ pysatNASA/instruments/methods/igs.py | 8 ++++++++ pysatNASA/instruments/methods/iss.py | 8 ++++++++ pysatNASA/instruments/methods/jhuapl.py | 8 ++++++++ pysatNASA/instruments/methods/maven.py | 8 ++++++++ pysatNASA/instruments/methods/omni.py | 8 ++++++++ pysatNASA/instruments/methods/reach.py | 8 ++++++++ pysatNASA/instruments/methods/ses14.py | 8 ++++++++ pysatNASA/instruments/methods/timed.py | 8 ++++++++ 19 files changed, 154 insertions(+) diff --git a/pysatNASA/instruments/methods/__init__.py b/pysatNASA/instruments/methods/__init__.py index a1910352..a11139e8 100644 --- a/pysatNASA/instruments/methods/__init__.py +++ b/pysatNASA/instruments/methods/__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. +# ---------------------------------------------------------------------------- """Methods for pysatNASA instruments.""" from pysatNASA.instruments.methods._cdf import CDF # noqa F401 diff --git a/pysatNASA/instruments/methods/_cdf.py b/pysatNASA/instruments/methods/_cdf.py index 06d4869e..34f6dd10 100644 --- a/pysatNASA/instruments/methods/_cdf.py +++ b/pysatNASA/instruments/methods/_cdf.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. +# ---------------------------------------------------------------------------- """Provides CDF class to parse cdaweb CDF files.""" import datetime as dt diff --git a/pysatNASA/instruments/methods/ace.py b/pysatNASA/instruments/methods/ace.py index f9e78412..e91df143 100644 --- a/pysatNASA/instruments/methods/ace.py +++ b/pysatNASA/instruments/methods/ace.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for ACE data.""" from pysatNASA.instruments.methods import cdaweb as cdw diff --git a/pysatNASA/instruments/methods/cdaweb.py b/pysatNASA/instruments/methods/cdaweb.py index 6846e52e..1a3b1382 100644 --- a/pysatNASA/instruments/methods/cdaweb.py +++ b/pysatNASA/instruments/methods/cdaweb.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. +# ---------------------------------------------------------------------------- """Provides default routines for NASA CDAWeb instruments into pysat. Note diff --git a/pysatNASA/instruments/methods/cnofs.py b/pysatNASA/instruments/methods/cnofs.py index c28166bd..094dd1de 100644 --- a/pysatNASA/instruments/methods/cnofs.py +++ b/pysatNASA/instruments/methods/cnofs.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for C/NOFS data.""" ackn_str = ' '.join(("The Communication Navigation Outage Forecast System", diff --git a/pysatNASA/instruments/methods/de2.py b/pysatNASA/instruments/methods/de2.py index 8e44575d..027511c9 100644 --- a/pysatNASA/instruments/methods/de2.py +++ b/pysatNASA/instruments/methods/de2.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for DE2 data.""" ackn_str = "The Dynamics Explorer 2 satellite data is provided through CDAWeb" diff --git a/pysatNASA/instruments/methods/dmsp.py b/pysatNASA/instruments/methods/dmsp.py index 3f930c0b..16b55753 100644 --- a/pysatNASA/instruments/methods/dmsp.py +++ b/pysatNASA/instruments/methods/dmsp.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for the DMSP data.""" ackn_str = "".join(["This Defense Meteorological Satellite Program (DMSP) ", diff --git a/pysatNASA/instruments/methods/formosat.py b/pysatNASA/instruments/methods/formosat.py index 840acd12..75c1ef56 100644 --- a/pysatNASA/instruments/methods/formosat.py +++ b/pysatNASA/instruments/methods/formosat.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for FORMOSAT data.""" ackn_str = ' '.join(('Data provided through NASA CDAWeb Key Parameters -', diff --git a/pysatNASA/instruments/methods/general.py b/pysatNASA/instruments/methods/general.py index 16326279..1b22893e 100644 --- a/pysatNASA/instruments/methods/general.py +++ b/pysatNASA/instruments/methods/general.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. +# ---------------------------------------------------------------------------- """General methods for NASA instruments.""" import numpy as np diff --git a/pysatNASA/instruments/methods/gps.py b/pysatNASA/instruments/methods/gps.py index 684ab544..0535b4a6 100644 --- a/pysatNASA/instruments/methods/gps.py +++ b/pysatNASA/instruments/methods/gps.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for JPL ROTI data. .. deprecated:: 0.0.5 diff --git a/pysatNASA/instruments/methods/icon.py b/pysatNASA/instruments/methods/icon.py index 0ecea2a5..361eb30f 100644 --- a/pysatNASA/instruments/methods/icon.py +++ b/pysatNASA/instruments/methods/icon.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for ICON data.""" from pysat.instruments.methods import general as mm_gen diff --git a/pysatNASA/instruments/methods/igs.py b/pysatNASA/instruments/methods/igs.py index c050e447..41877f62 100644 --- a/pysatNASA/instruments/methods/igs.py +++ b/pysatNASA/instruments/methods/igs.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for IGS GPS data.""" ackn_str = ' '.join(("The GPS Total Electron Content (TEC) data", diff --git a/pysatNASA/instruments/methods/iss.py b/pysatNASA/instruments/methods/iss.py index dd7553e4..b83046a7 100644 --- a/pysatNASA/instruments/methods/iss.py +++ b/pysatNASA/instruments/methods/iss.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for ISS data.""" ackn_str = ' '.join(("R.M. Suggs, S.L. Koontz, NASA Johnson Space Center", diff --git a/pysatNASA/instruments/methods/jhuapl.py b/pysatNASA/instruments/methods/jhuapl.py index 51d0be22..eed9bd4b 100644 --- a/pysatNASA/instruments/methods/jhuapl.py +++ b/pysatNASA/instruments/methods/jhuapl.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 data sets created by JHU APL.""" import datetime as dt diff --git a/pysatNASA/instruments/methods/maven.py b/pysatNASA/instruments/methods/maven.py index d6a5aa6f..1a00fb74 100644 --- a/pysatNASA/instruments/methods/maven.py +++ b/pysatNASA/instruments/methods/maven.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for MAVEN data. Created on Thu Jul 13 11:21:01 2023 diff --git a/pysatNASA/instruments/methods/omni.py b/pysatNASA/instruments/methods/omni.py index 178e91cb..a6c3df46 100644 --- a/pysatNASA/instruments/methods/omni.py +++ b/pysatNASA/instruments/methods/omni.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 OMNI HRO supporting functions.""" diff --git a/pysatNASA/instruments/methods/reach.py b/pysatNASA/instruments/methods/reach.py index cc9b11e1..7c6832c3 100644 --- a/pysatNASA/instruments/methods/reach.py +++ b/pysatNASA/instruments/methods/reach.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for REACH data.""" ackn_str = "Please load a file for full acknowledgments." diff --git a/pysatNASA/instruments/methods/ses14.py b/pysatNASA/instruments/methods/ses14.py index 5307d592..ab81daa1 100644 --- a/pysatNASA/instruments/methods/ses14.py +++ b/pysatNASA/instruments/methods/ses14.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for SES14 instruments.""" ackn_str = ' '.join(('This is a data product from the NASA Global-scale', diff --git a/pysatNASA/instruments/methods/timed.py b/pysatNASA/instruments/methods/timed.py index 726dc800..d12b5041 100644 --- a/pysatNASA/instruments/methods/timed.py +++ b/pysatNASA/instruments/methods/timed.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. +# ---------------------------------------------------------------------------- """Provides non-instrument specific routines for the TIMED data.""" rules_url = {'guvi': 'http://guvitimed.jhuapl.edu/home_guvi-datausage', From b58fc226de96f9281e4d478c3236415b3cae37c5 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:28:42 -0400 Subject: [PATCH 07/15] DOC: updated CDAWeb template Updated the CDAWeb instrument template and docstring to include the NRL pub release and instruct users to not include it in new files. --- .../templates/template_cdaweb_instrument.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/pysatNASA/instruments/templates/template_cdaweb_instrument.py b/pysatNASA/instruments/templates/template_cdaweb_instrument.py index 4745e82b..8c145998 100644 --- a/pysatNASA/instruments/templates/template_cdaweb_instrument.py +++ b/pysatNASA/instruments/templates/template_cdaweb_instrument.py @@ -1,8 +1,18 @@ +#!/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. +# ---------------------------------------------------------------------------- """Template for a pysat.Instrument support file that utilizes CDAWeb methods. Copy and modify this file as needed when adding a new Instrument to pysat. +DO NOT include the NRL distribution statement in your new file. + This is a good area to introduce the instrument, provide background on the mission, operations, instrumenation, and measurements. From 28d800a5940bdc21ac1ab1140ca47101062927e7 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:30:15 -0400 Subject: [PATCH 08/15] DOC: updated test headers Added NRL pub release to the pysatNASA unit and integration tests. --- pysatNASA/tests/__init__.py | 9 +++++++++ pysatNASA/tests/test_instruments.py | 9 +++++++++ pysatNASA/tests/test_methods_cdaweb.py | 9 +++++++++ pysatNASA/tests/test_methods_jhuapl.py | 9 +++++++++ pysatNASA/tests/test_methods_platform.py | 9 +++++++++ pysatNASA/tests/test_omni_hro.py | 9 +++++++++ 6 files changed, 54 insertions(+) diff --git a/pysatNASA/tests/__init__.py b/pysatNASA/tests/__init__.py index 438e2465..61c89a45 100644 --- a/pysatNASA/tests/__init__.py +++ b/pysatNASA/tests/__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. +# ---------------------------------------------------------------------------- """Unit and Integration Tests for pysatNASA. Note diff --git a/pysatNASA/tests/test_instruments.py b/pysatNASA/tests/test_instruments.py index ea15eba5..821dfe58 100644 --- a/pysatNASA/tests/test_instruments.py +++ b/pysatNASA/tests/test_instruments.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. +# ---------------------------------------------------------------------------- """Unit and Integration Tests for each instrument module. Note diff --git a/pysatNASA/tests/test_methods_cdaweb.py b/pysatNASA/tests/test_methods_cdaweb.py index 640c2b46..c5184a06 100644 --- a/pysatNASA/tests/test_methods_cdaweb.py +++ b/pysatNASA/tests/test_methods_cdaweb.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. +# ---------------------------------------------------------------------------- """Unit tests for the cdaweb instrument methods.""" import datetime as dt diff --git a/pysatNASA/tests/test_methods_jhuapl.py b/pysatNASA/tests/test_methods_jhuapl.py index b3d26cff..c3e4ea0e 100644 --- a/pysatNASA/tests/test_methods_jhuapl.py +++ b/pysatNASA/tests/test_methods_jhuapl.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. +# ---------------------------------------------------------------------------- """Unit tests for the JHU APL instrument methods.""" import datetime as dt diff --git a/pysatNASA/tests/test_methods_platform.py b/pysatNASA/tests/test_methods_platform.py index a1cd6611..1cd2d2b6 100644 --- a/pysatNASA/tests/test_methods_platform.py +++ b/pysatNASA/tests/test_methods_platform.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. +# ---------------------------------------------------------------------------- """Unit tests for the common NASA platform method attributes.""" diff --git a/pysatNASA/tests/test_omni_hro.py b/pysatNASA/tests/test_omni_hro.py index 1bd95fc4..eb2f0311 100644 --- a/pysatNASA/tests/test_omni_hro.py +++ b/pysatNASA/tests/test_omni_hro.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. +# ---------------------------------------------------------------------------- """Unit tests for OMNI HRO special functions.""" import datetime as dt From 195d85969a4ca621a17357f031b471949467222a Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:45:04 -0400 Subject: [PATCH 09/15] MAINT: updated .gitignore Added the current default build directory for local documentation to .gitignore. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index c8350919..3946fb04 100644 --- a/.gitignore +++ b/.gitignore @@ -56,6 +56,7 @@ coverage.xml # Sphinx documentation docs/_build/ +docs/.build/ # PyBuilder target/ From 9c63b672ebeccb5df9ca45f1bf4a8a97e4629a4f Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:45:49 -0400 Subject: [PATCH 10/15] DOC: updated linked text Updated text to: - have the correct line length, - use better grammar, and - not have duplicate text with different links. --- docs/archival.rst | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/archival.rst b/docs/archival.rst index ad1b1d5e..833905d5 100644 --- a/docs/archival.rst +++ b/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 `_. 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 `_. +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 `_. +`at SPDF `_. -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. :: From 7b8ffcbb88bfaa2c59dfafaa0db175c7c4e7058b Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:46:10 -0400 Subject: [PATCH 11/15] MAINT: updated conf.py Updated the interspinx mapping format as suggested in the deprecation warning. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 8c23a0b8..32a3e9fb 100644 --- a/docs/conf.py +++ b/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 = {'': ('https://docs.python.org/', None)} # Links to ignore, as they require human interaction linkcheck_ignore = [r'https://saber.gats-inc.com/temp_errors.php'] From b2add3e36a03a00c04a59190949e9f20fa3bac13 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:46:23 -0400 Subject: [PATCH 12/15] BUG: fixed typo Fixed a typo in the index file. --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 65122f8d..44fa57f1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,7 +20,7 @@ CDAWeb interface. develop_guide.rst archival.rst migration_guide.rst - acnkowledgements.rst + acknowledgements.rst history.rst From 2ea44f54d227de5e424b976579219d97337bede3 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 28 Mar 2024 12:47:07 -0400 Subject: [PATCH 13/15] BUG: fixed supported Instrument formatting Fixed supported instrument reference links, automodule calls, and title underlines. --- docs/supported_instruments.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/supported_instruments.rst b/docs/supported_instruments.rst index f0300466..d29d4c3f 100644 --- a/docs/supported_instruments.rst +++ b/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: From 135d3a9314544b9d477622fbe4970c0e5c6bc2b9 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 12 Jul 2024 11:00:13 -0400 Subject: [PATCH 14/15] DOC: fixed acknowledgements Fixed the headers in the acknowledgements document. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com> --- ACKNOWLEDGEMENTS.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index 182d6e6c..a50db5f5 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -4,10 +4,6 @@ The following institutions, missions, and programs have provided funding for pysatNASA development. Institutions ------------- -- Alphabetical list of institutions - -Missions -------- - The Catholic University of America (CUA) - Cosmic Studio @@ -17,7 +13,7 @@ Missions - National Science Foundation (NSF) - Office of Naval Research (ONR) -Programs +Missions -------- - NASA Ionospheric Connections Explorer (ICON) - NASA Scintillation Observations and Response of the Ionosphere to From fea00360a0ecfcca7b2da0f2b93f6c6f2f40696c Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 12 Jul 2024 11:00:54 -0400 Subject: [PATCH 15/15] DOC: Update ACKNOWLEDGEMENTS.md Fixed length of section underline. --- ACKNOWLEDGEMENTS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index a50db5f5..22c05861 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -4,7 +4,7 @@ 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