From 43fcb1ad5c298949563759d1871a3531c5e65af4 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 6 Sep 2024 15:40:46 -0400 Subject: [PATCH 1/4] DOC: added acknowledgements Added acknowledgements to the repository and documentation. --- ACKNOWLEDGEMENTS.md | 34 ++++++++++++++++++++++++++++++++++ docs/acknowledgements.rst | 1 + 2 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 0000000..a6fdcfb --- /dev/null +++ b/ACKNOWLEDGEMENTS.md @@ -0,0 +1,34 @@ +Funding +======= +The following institutions, missions, and programs have provided funding +for pysat 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 +-------- + - NOAA Constellation Observing System for Meteorology Ionosphere and Climate + (COSMIC-2) + +Programs +-------- + - NSF 125908, AGS-1651393 + - NASA Space Precipitation Impacts (SPI) project at Goddard Space Flight Center + through the Heliophysics Internal Science Funding Model. + - Naval Research Laboratory N00173191G016 and N0017322P0744 + +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 0000000..dd1f917 --- /dev/null +++ b/docs/acknowledgements.rst @@ -0,0 +1 @@ +.. mdinclude:: ../ACKNOWLEDGEMENTS.md From ae7359b60ff3c5bc7a6a9b0a0966971b57edbe31 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 6 Sep 2024 15:41:13 -0400 Subject: [PATCH 2/4] DOC: updated doc index Added the acknowledgements and pub release statement to the documentation. --- docs/index.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index fc599d2..dffb5e6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,11 @@ Center (CDAAC) 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 From cea00f9018e7ed06309cd7922d9a2592e8d66b5f Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 6 Sep 2024 15:41:29 -0400 Subject: [PATCH 3/4] DOC: updated header Added the pub release header to the code. --- docs/conf.py | 6 ++++++ pysatCDAAC/__init__.py | 7 +++++++ pysatCDAAC/instruments/__init__.py | 6 ++++++ pysatCDAAC/instruments/cosmic2_ivm.py | 6 ++++++ pysatCDAAC/instruments/cosmic_gps.py | 6 ++++++ pysatCDAAC/instruments/methods/__init__.py | 7 +++++++ pysatCDAAC/instruments/methods/general.py | 6 ++++++ pysatCDAAC/tests/__init__.py | 7 +++++++ pysatCDAAC/tests/test_instruments.py | 7 +++++++ 9 files changed, 58 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 3b1c205..f54850c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,10 @@ # -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# 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/pysatCDAAC/__init__.py b/pysatCDAAC/__init__.py index d89ebcf..a0786ed 100644 --- a/pysatCDAAC/__init__.py +++ b/pysatCDAAC/__init__.py @@ -1,3 +1,10 @@ +# -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# DOI:10.5281/zenodo.3475493 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# ---------------------------------------------------------------------------- """Core library for pysatCDAAC. This is a library of `pysat` instrument modules and methods designed to support diff --git a/pysatCDAAC/instruments/__init__.py b/pysatCDAAC/instruments/__init__.py index d560b67..23ecec2 100644 --- a/pysatCDAAC/instruments/__init__.py +++ b/pysatCDAAC/instruments/__init__.py @@ -1,4 +1,10 @@ # -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# DOI:10.5281/zenodo.3475493 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# ---------------------------------------------------------------------------- """Collection of instruments for the pysatCDAAC library. Each instrument is contained within a subpackage of this set. diff --git a/pysatCDAAC/instruments/cosmic2_ivm.py b/pysatCDAAC/instruments/cosmic2_ivm.py index 381037f..31c36b5 100644 --- a/pysatCDAAC/instruments/cosmic2_ivm.py +++ b/pysatCDAAC/instruments/cosmic2_ivm.py @@ -1,4 +1,10 @@ # -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# DOI:10.5281/zenodo.3475493 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# ---------------------------------------------------------------------------- """Supports IVM data from the COSMIC2 satellite. The Constellation Observing System for Meteorology, Ionosphere, and Climate diff --git a/pysatCDAAC/instruments/cosmic_gps.py b/pysatCDAAC/instruments/cosmic_gps.py index 6c940c6..2edddba 100644 --- a/pysatCDAAC/instruments/cosmic_gps.py +++ b/pysatCDAAC/instruments/cosmic_gps.py @@ -1,4 +1,10 @@ # -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# DOI:10.5281/zenodo.3475493 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# ---------------------------------------------------------------------------- """Loads data from the COSMIC satellite. The Constellation Observing System for Meteorology, Ionosphere, and Climate diff --git a/pysatCDAAC/instruments/methods/__init__.py b/pysatCDAAC/instruments/methods/__init__.py index 94bf561..4aa040f 100644 --- a/pysatCDAAC/instruments/methods/__init__.py +++ b/pysatCDAAC/instruments/methods/__init__.py @@ -1,3 +1,10 @@ +# -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# DOI:10.5281/zenodo.3475493 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# ---------------------------------------------------------------------------- """Methods for pysatCDAAC instruments.""" from pysatCDAAC.instruments.methods import general # noqa F401 diff --git a/pysatCDAAC/instruments/methods/general.py b/pysatCDAAC/instruments/methods/general.py index 3dd257b..1f3cda7 100644 --- a/pysatCDAAC/instruments/methods/general.py +++ b/pysatCDAAC/instruments/methods/general.py @@ -1,4 +1,10 @@ # -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# DOI:10.5281/zenodo.3475493 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# ---------------------------------------------------------------------------- """Provides default routines for CDAAC instruments into pysat.""" import os diff --git a/pysatCDAAC/tests/__init__.py b/pysatCDAAC/tests/__init__.py index c4b0690..46a1355 100644 --- a/pysatCDAAC/tests/__init__.py +++ b/pysatCDAAC/tests/__init__.py @@ -1,3 +1,10 @@ +# -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# DOI:10.5281/zenodo.3475493 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# ---------------------------------------------------------------------------- """Unit and Integration Tests for pysatCDAAC. Note diff --git a/pysatCDAAC/tests/test_instruments.py b/pysatCDAAC/tests/test_instruments.py index 0b97446..5c242de 100644 --- a/pysatCDAAC/tests/test_instruments.py +++ b/pysatCDAAC/tests/test_instruments.py @@ -1,3 +1,10 @@ +# -*- coding: utf-8 -*- +# Full author list can be found in .zenodo.json file +# DOI:10.5281/zenodo.3475493 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# ---------------------------------------------------------------------------- """Unit and Integration Tests for each instrument module. Note From 0968adc110c95981f7dac1119bcf1a621b9a5fc1 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 6 Sep 2024 15:48:51 -0400 Subject: [PATCH 4/4] DOC: fixed package name Updated the package name to be correct. --- ACKNOWLEDGEMENTS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index a6fdcfb..6d1e120 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -1,7 +1,7 @@ Funding ======= The following institutions, missions, and programs have provided funding -for pysat development. +for pysatCDAAC development. Institutions ------------ @@ -28,7 +28,7 @@ Programs 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 +the institutions and do not necessarily reflect the views of the pysatCDAAC 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.