From 96713d54bea10ba780999c4b630c78e6324e7e43 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 19 Dec 2023 14:43:38 -0500 Subject: [PATCH 1/7] REL: update version number Update version number in preparation for release. --- pyproject.toml | 2 +- setup.cfg | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 74cdda8..31a4351 100644 --- 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/setup.cfg b/setup.cfg index a2f4510..aa9e557 100644 --- 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 From bfd2ae3cee794665fab9847428a055bf7aa9f383 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 19 Dec 2023 14:44:04 -0500 Subject: [PATCH 2/7] REL: update changelog Update the changelog release version number and target date. --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 094d7b8..e51b9a3 100644 --- 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-01-10 -------------------- * Enhancements * Moved the OMNI-2 IMF, Dst, and Geomagnetic index Instruments from the From 228af42abb86d18a99fd73b523da0619e93d7baa Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 31 Jan 2024 16:37:48 -0500 Subject: [PATCH 3/7] DOC: add acknowledgements Add acknowledgements to the documentation and the main directory. --- ACKNOWLEDGEMENTS.md | 28 ++++++++++++++++++++++++++++ docs/acknowledgements.rst | 1 + docs/index.rst | 5 +++++ 3 files changed, 34 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..a1b7ddd --- /dev/null +++ b/ACKNOWLEDGEMENTS.md @@ -0,0 +1,28 @@ +Funding +======= +The following institutions, missions, and programs have provided funding +for pysatSpaceWeather development. + +Institutions +------------ + - 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/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 diff --git a/docs/index.rst b/docs/index.rst index 4787575..899f928 100644 --- 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 From 0db87d16d6b72a152215ba8a96add52a0969ed8a Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 31 Jan 2024 16:38:13 -0500 Subject: [PATCH 4/7] DOC: update file headers Update the code file headers to include the NRL pub release. --- pysatMadrigal/instruments/dmsp_ivm.py | 7 ++++--- pysatMadrigal/instruments/dmsp_ssj.py | 5 ++++- pysatMadrigal/instruments/gnss_tec.py | 10 +++++++++- pysatMadrigal/instruments/jro_isr.py | 5 ++++- pysatMadrigal/instruments/madrigal_dst.py | 5 ++++- pysatMadrigal/instruments/madrigal_geoind.py | 5 ++++- pysatMadrigal/instruments/methods/dmsp.py | 5 ++++- pysatMadrigal/instruments/methods/general.py | 5 ++++- pysatMadrigal/instruments/methods/gnss.py | 5 ++++- pysatMadrigal/instruments/methods/jro.py | 5 ++++- pysatMadrigal/instruments/ngdc_ae.py | 5 ++++- pysatMadrigal/instruments/omni2_imf.py | 5 ++++- pysatMadrigal/tests/test_instruments.py | 4 ++++ pysatMadrigal/tests/test_methods_dmsp.py | 6 +++++- pysatMadrigal/tests/test_methods_general.py | 4 ++++ pysatMadrigal/tests/test_methods_gnss.py | 4 ++++ pysatMadrigal/tests/test_methods_jro.py | 4 ++++ pysatMadrigal/tests/test_utils_coords.py | 9 +++++++++ pysatMadrigal/utils/coords.py | 4 ++++ 19 files changed, 87 insertions(+), 15 deletions(-) diff --git a/pysatMadrigal/instruments/dmsp_ivm.py b/pysatMadrigal/instruments/dmsp_ivm.py index 1855e5a..980718a 100644 --- 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 index 21c4cb6..fcdc313 100644 --- 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 index a51b496..b922096 100644 --- 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 index b500a72..f4bf99f 100644 --- 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 index 8dea5a5..7324c59 100644 --- 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 index 0cf19d3..be288b0 100644 --- 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 index 42be397..0eb4c56 100644 --- 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 index 7eb04fa..4ca23bd 100644 --- 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 index eb3b620..0283a18 100644 --- 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 index 880f7bb..4d8dcf3 100644 --- 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 index 7cb1e54..67aa42e 100644 --- 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 index d06296e..cbadac5 100644 --- 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 index 40a2110..20277db 100644 --- 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 index cc0f1bc..1d0efd7 100644 --- 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 index 8d817c7..500346a 100644 --- 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 index e50f1cf..6338974 100644 --- 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 index b3278d2..3994649 100644 --- 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 index 28ec880..2664d8e 100644 --- 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 index e5db684..d95ba58 100644 --- 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.""" From fb4f357ab6b94272664d0b89df5e4f81f2de6926 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 1 Feb 2024 11:18:12 -0500 Subject: [PATCH 5/7] MAINT: updated readme Updated the readme install instructions and fixed a typo in the example. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0ae27ba..cbeb110 100644 --- 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 From d44601bd6300971b9538b5bf366f99f00db28356 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 21 Feb 2024 16:48:13 -0500 Subject: [PATCH 6/7] DOC: Update CHANGELOG.md Update the targeted release date to unspecified in preparation for a separate release candidate branch. --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e51b9a3..361d67f 100644 --- 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.2.0] - 2024-01-10 +[0.2.0] - 2024-XX-XX -------------------- * Enhancements * Moved the OMNI-2 IMF, Dst, and Geomagnetic index Instruments from the From 48964fa4cc2db4b3c31d63876a2f87ada09003d9 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Sun, 25 Feb 2024 23:18:09 -0500 Subject: [PATCH 7/7] MAINT: update acknowledgements Update the acknowledgements. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com> --- ACKNOWLEDGEMENTS.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index a1b7ddd..4354ddc 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -1,10 +1,11 @@ Funding ======= The following institutions, missions, and programs have provided funding -for pysatSpaceWeather development. +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)