From 96b020fd25a4e81d0a073a3f0f562de0d875ae8a Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 1 Dec 2023 19:14:52 -0500 Subject: [PATCH 01/31] DOC: update instrument headers Update the instrument headers to include license, reference, and pub release information. --- pysatSpaceWeather/instruments/ace_epam.py | 11 ++++++++++- pysatSpaceWeather/instruments/ace_mag.py | 11 ++++++++++- pysatSpaceWeather/instruments/ace_sis.py | 11 ++++++++++- pysatSpaceWeather/instruments/ace_swepam.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_ae.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_al.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_ap.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_apo.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_au.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_cp.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_dst.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_f107.py | 4 ++++ pysatSpaceWeather/instruments/sw_flare.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_hpo.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_kp.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_mgii.py | 4 ++++ pysatSpaceWeather/instruments/sw_polarcap.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_sbfield.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_ssn.py | 11 ++++++++++- pysatSpaceWeather/instruments/sw_stormprob.py | 11 ++++++++++- 20 files changed, 188 insertions(+), 18 deletions(-) diff --git a/pysatSpaceWeather/instruments/ace_epam.py b/pysatSpaceWeather/instruments/ace_epam.py index 40ddf5dd..171e069d 100644 --- a/pysatSpaceWeather/instruments/ace_epam.py +++ b/pysatSpaceWeather/instruments/ace_epam.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports ACE Electron, Proton, and Alpha Monitor data. Properties diff --git a/pysatSpaceWeather/instruments/ace_mag.py b/pysatSpaceWeather/instruments/ace_mag.py index cfccde8c..f8529708 100644 --- a/pysatSpaceWeather/instruments/ace_mag.py +++ b/pysatSpaceWeather/instruments/ace_mag.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports ACE Magnetometer data. Properties diff --git a/pysatSpaceWeather/instruments/ace_sis.py b/pysatSpaceWeather/instruments/ace_sis.py index 32147ac7..1c8a5a7c 100644 --- a/pysatSpaceWeather/instruments/ace_sis.py +++ b/pysatSpaceWeather/instruments/ace_sis.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports ACE Solar Isotope Spectrometer data. Properties diff --git a/pysatSpaceWeather/instruments/ace_swepam.py b/pysatSpaceWeather/instruments/ace_swepam.py index d3178f5d..3388d6d2 100644 --- a/pysatSpaceWeather/instruments/ace_swepam.py +++ b/pysatSpaceWeather/instruments/ace_swepam.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports ACE Solar Wind Electron Proton Alpha Monitor data. Properties diff --git a/pysatSpaceWeather/instruments/sw_ae.py b/pysatSpaceWeather/instruments/sw_ae.py index aa907273..a5e63b23 100644 --- a/pysatSpaceWeather/instruments/sw_ae.py +++ b/pysatSpaceWeather/instruments/sw_ae.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports the auroral electrojet AE values. Properties diff --git a/pysatSpaceWeather/instruments/sw_al.py b/pysatSpaceWeather/instruments/sw_al.py index 012614af..eff8c377 100644 --- a/pysatSpaceWeather/instruments/sw_al.py +++ b/pysatSpaceWeather/instruments/sw_al.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports the auroral electrojet AL values. Properties diff --git a/pysatSpaceWeather/instruments/sw_ap.py b/pysatSpaceWeather/instruments/sw_ap.py index 620a3aac..dc26c129 100644 --- a/pysatSpaceWeather/instruments/sw_ap.py +++ b/pysatSpaceWeather/instruments/sw_ap.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports ap index values. Properties diff --git a/pysatSpaceWeather/instruments/sw_apo.py b/pysatSpaceWeather/instruments/sw_apo.py index c2a1a25a..0357bfb1 100644 --- a/pysatSpaceWeather/instruments/sw_apo.py +++ b/pysatSpaceWeather/instruments/sw_apo.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports apo index values. Properties diff --git a/pysatSpaceWeather/instruments/sw_au.py b/pysatSpaceWeather/instruments/sw_au.py index e759c179..392fca5f 100644 --- a/pysatSpaceWeather/instruments/sw_au.py +++ b/pysatSpaceWeather/instruments/sw_au.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports the auroral electrojet AU values. Properties diff --git a/pysatSpaceWeather/instruments/sw_cp.py b/pysatSpaceWeather/instruments/sw_cp.py index 1bd629b6..f2788bf6 100644 --- a/pysatSpaceWeather/instruments/sw_cp.py +++ b/pysatSpaceWeather/instruments/sw_cp.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports Cp index values. Properties diff --git a/pysatSpaceWeather/instruments/sw_dst.py b/pysatSpaceWeather/instruments/sw_dst.py index ed64a664..a9325b36 100644 --- a/pysatSpaceWeather/instruments/sw_dst.py +++ b/pysatSpaceWeather/instruments/sw_dst.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports Dst values. Downloads data from NGDC. Properties diff --git a/pysatSpaceWeather/instruments/sw_f107.py b/pysatSpaceWeather/instruments/sw_f107.py index ffd54136..92e33e42 100644 --- a/pysatSpaceWeather/instruments/sw_f107.py +++ b/pysatSpaceWeather/instruments/sw_f107.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports F10.7 index values. diff --git a/pysatSpaceWeather/instruments/sw_flare.py b/pysatSpaceWeather/instruments/sw_flare.py index e510811d..83d3da45 100644 --- a/pysatSpaceWeather/instruments/sw_flare.py +++ b/pysatSpaceWeather/instruments/sw_flare.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports solar flare values. Properties diff --git a/pysatSpaceWeather/instruments/sw_hpo.py b/pysatSpaceWeather/instruments/sw_hpo.py index d0c822bc..758c4221 100644 --- a/pysatSpaceWeather/instruments/sw_hpo.py +++ b/pysatSpaceWeather/instruments/sw_hpo.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports Hpo index values. Properties diff --git a/pysatSpaceWeather/instruments/sw_kp.py b/pysatSpaceWeather/instruments/sw_kp.py index 13b6a13e..76aadb2f 100644 --- a/pysatSpaceWeather/instruments/sw_kp.py +++ b/pysatSpaceWeather/instruments/sw_kp.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports Kp index values. Properties diff --git a/pysatSpaceWeather/instruments/sw_mgii.py b/pysatSpaceWeather/instruments/sw_mgii.py index 9379c9b3..a9e2831e 100644 --- a/pysatSpaceWeather/instruments/sw_mgii.py +++ b/pysatSpaceWeather/instruments/sw_mgii.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports the MgII core-to-wing ratio index. diff --git a/pysatSpaceWeather/instruments/sw_polarcap.py b/pysatSpaceWeather/instruments/sw_polarcap.py index 0db8f0f3..e55abd7c 100644 --- a/pysatSpaceWeather/instruments/sw_polarcap.py +++ b/pysatSpaceWeather/instruments/sw_polarcap.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports polar cap indexes. Properties diff --git a/pysatSpaceWeather/instruments/sw_sbfield.py b/pysatSpaceWeather/instruments/sw_sbfield.py index 04a89c3b..c1361ed9 100644 --- a/pysatSpaceWeather/instruments/sw_sbfield.py +++ b/pysatSpaceWeather/instruments/sw_sbfield.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports solar magnetic field values. Properties diff --git a/pysatSpaceWeather/instruments/sw_ssn.py b/pysatSpaceWeather/instruments/sw_ssn.py index 6ecfd378..c70d7f74 100644 --- a/pysatSpaceWeather/instruments/sw_ssn.py +++ b/pysatSpaceWeather/instruments/sw_ssn.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports Sunspot Number (SSN) and related indices. Properties diff --git a/pysatSpaceWeather/instruments/sw_stormprob.py b/pysatSpaceWeather/instruments/sw_stormprob.py index 0fef92c9..345866d0 100644 --- a/pysatSpaceWeather/instruments/sw_stormprob.py +++ b/pysatSpaceWeather/instruments/sw_stormprob.py @@ -1,4 +1,13 @@ -# -*- 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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Supports storm probabilities. Properties From a20187db4642ccebc40bf5141119845360b20369 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 1 Dec 2023 19:15:29 -0500 Subject: [PATCH 02/31] DOC: update method headers Update the instrument method headers to include license, reference, and pub release information. --- pysatSpaceWeather/instruments/methods/ace.py | 4 ++++ .../instruments/methods/auroral_electrojet.py | 9 +++++++++ pysatSpaceWeather/instruments/methods/dst.py | 9 +++++++++ pysatSpaceWeather/instruments/methods/f107.py | 4 ++++ pysatSpaceWeather/instruments/methods/general.py | 9 +++++++++ pysatSpaceWeather/instruments/methods/gfz.py | 4 ++++ pysatSpaceWeather/instruments/methods/kp_ap.py | 4 ++++ pysatSpaceWeather/instruments/methods/lasp.py | 9 +++++++++ pysatSpaceWeather/instruments/methods/lisird.py | 4 ++++ pysatSpaceWeather/instruments/methods/swpc.py | 4 ++++ 10 files changed, 60 insertions(+) diff --git a/pysatSpaceWeather/instruments/methods/ace.py b/pysatSpaceWeather/instruments/methods/ace.py index ab180acc..4f52ed71 100644 --- a/pysatSpaceWeather/instruments/methods/ace.py +++ b/pysatSpaceWeather/instruments/methods/ace.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides general routines for the ACE space weather instruments.""" diff --git a/pysatSpaceWeather/instruments/methods/auroral_electrojet.py b/pysatSpaceWeather/instruments/methods/auroral_electrojet.py index 62835441..91864507 100644 --- a/pysatSpaceWeather/instruments/methods/auroral_electrojet.py +++ b/pysatSpaceWeather/instruments/methods/auroral_electrojet.py @@ -1,4 +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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Provides support routines for auroral electrojet indices.""" diff --git a/pysatSpaceWeather/instruments/methods/dst.py b/pysatSpaceWeather/instruments/methods/dst.py index 0eee65ae..ac062a51 100644 --- a/pysatSpaceWeather/instruments/methods/dst.py +++ b/pysatSpaceWeather/instruments/methods/dst.py @@ -1,4 +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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Provides default routines for Dst.""" diff --git a/pysatSpaceWeather/instruments/methods/f107.py b/pysatSpaceWeather/instruments/methods/f107.py index 775cef7d..1e5278d1 100644 --- a/pysatSpaceWeather/instruments/methods/f107.py +++ b/pysatSpaceWeather/instruments/methods/f107.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Routines for the F10.7 solar index.""" diff --git a/pysatSpaceWeather/instruments/methods/general.py b/pysatSpaceWeather/instruments/methods/general.py index eea99d2e..9bdff66b 100644 --- a/pysatSpaceWeather/instruments/methods/general.py +++ b/pysatSpaceWeather/instruments/methods/general.py @@ -1,4 +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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Provides routines that support general space weather instruments.""" import importlib diff --git a/pysatSpaceWeather/instruments/methods/gfz.py b/pysatSpaceWeather/instruments/methods/gfz.py index 6ff684f5..53ca3e35 100644 --- a/pysatSpaceWeather/instruments/methods/gfz.py +++ b/pysatSpaceWeather/instruments/methods/gfz.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides routines that support GFZ space weather instruments.""" diff --git a/pysatSpaceWeather/instruments/methods/kp_ap.py b/pysatSpaceWeather/instruments/methods/kp_ap.py index b6498bbf..8454ffdb 100644 --- a/pysatSpaceWeather/instruments/methods/kp_ap.py +++ b/pysatSpaceWeather/instruments/methods/kp_ap.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides routines to support the geomagnetic indices, Kp and Ap.""" diff --git a/pysatSpaceWeather/instruments/methods/lasp.py b/pysatSpaceWeather/instruments/methods/lasp.py index c8688d44..98fdd709 100644 --- a/pysatSpaceWeather/instruments/methods/lasp.py +++ b/pysatSpaceWeather/instruments/methods/lasp.py @@ -1,4 +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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Provides support routines for LASP data.""" import datetime as dt diff --git a/pysatSpaceWeather/instruments/methods/lisird.py b/pysatSpaceWeather/instruments/methods/lisird.py index 9e444914..48e819a5 100644 --- a/pysatSpaceWeather/instruments/methods/lisird.py +++ b/pysatSpaceWeather/instruments/methods/lisird.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides support functions for the LASP LISIRD data base.""" diff --git a/pysatSpaceWeather/instruments/methods/swpc.py b/pysatSpaceWeather/instruments/methods/swpc.py index f6c58569..f5df5492 100644 --- a/pysatSpaceWeather/instruments/methods/swpc.py +++ b/pysatSpaceWeather/instruments/methods/swpc.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides routines that support SWPC space weather instruments.""" From bd3d34a7c155260a5abb9e235964366697965dcb Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 1 Dec 2023 19:15:46 -0500 Subject: [PATCH 03/31] DOC: update test headers Update the test file headers to include license, reference, and pub release information. --- pysatSpaceWeather/tests/test_instruments.py | 10 ++++++++++ pysatSpaceWeather/tests/test_methods_ace.py | 4 ++++ pysatSpaceWeather/tests/test_methods_ae.py | 4 ++++ pysatSpaceWeather/tests/test_methods_f107.py | 4 ++++ pysatSpaceWeather/tests/test_methods_general.py | 4 ++++ pysatSpaceWeather/tests/test_methods_gfz.py | 4 ++++ pysatSpaceWeather/tests/test_methods_kp.py | 4 ++++ pysatSpaceWeather/tests/test_methods_lisird.py | 4 ++++ 8 files changed, 38 insertions(+) diff --git a/pysatSpaceWeather/tests/test_instruments.py b/pysatSpaceWeather/tests/test_instruments.py index 9f4f9502..5c572cb5 100644 --- a/pysatSpaceWeather/tests/test_instruments.py +++ b/pysatSpaceWeather/tests/test_instruments.py @@ -1,3 +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.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. +# ---------------------------------------------------------------------------- """Unit and Integration Tests for each instrument module. Note diff --git a/pysatSpaceWeather/tests/test_methods_ace.py b/pysatSpaceWeather/tests/test_methods_ace.py index b84b7bdd..52f982df 100644 --- a/pysatSpaceWeather/tests/test_methods_ace.py +++ b/pysatSpaceWeather/tests/test_methods_ace.py @@ -2,6 +2,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Integration and unit test suite for ACE methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_ae.py b/pysatSpaceWeather/tests/test_methods_ae.py index 6ce68847..d9339e5b 100644 --- a/pysatSpaceWeather/tests/test_methods_ae.py +++ b/pysatSpaceWeather/tests/test_methods_ae.py @@ -2,6 +2,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Integration and unit test suite for AE methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_f107.py b/pysatSpaceWeather/tests/test_methods_f107.py index 70c98451..d35910c2 100644 --- a/pysatSpaceWeather/tests/test_methods_f107.py +++ b/pysatSpaceWeather/tests/test_methods_f107.py @@ -2,6 +2,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Test suite for F10.7 methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_general.py b/pysatSpaceWeather/tests/test_methods_general.py index 031ec5c5..da244760 100644 --- a/pysatSpaceWeather/tests/test_methods_general.py +++ b/pysatSpaceWeather/tests/test_methods_general.py @@ -2,6 +2,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Integration and unit test suite for ACE methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_gfz.py b/pysatSpaceWeather/tests/test_methods_gfz.py index 87436aaf..cae7b50a 100644 --- a/pysatSpaceWeather/tests/test_methods_gfz.py +++ b/pysatSpaceWeather/tests/test_methods_gfz.py @@ -2,6 +2,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Integration and unit test suite for ACE methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_kp.py b/pysatSpaceWeather/tests/test_methods_kp.py index 88b4b9aa..8cfbacf5 100644 --- a/pysatSpaceWeather/tests/test_methods_kp.py +++ b/pysatSpaceWeather/tests/test_methods_kp.py @@ -2,6 +2,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Test suite for Kp and Ap methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_lisird.py b/pysatSpaceWeather/tests/test_methods_lisird.py index 7ea36189..77018a18 100644 --- a/pysatSpaceWeather/tests/test_methods_lisird.py +++ b/pysatSpaceWeather/tests/test_methods_lisird.py @@ -3,6 +3,10 @@ # Full license can be found in License.md # Full author list can be found in .zenodo.json file # DOI:10.5281/zenodo.3986138 +# +# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is +# unlimited. +# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Tests for the LISIRD functions.""" From 818260fe36f0de0e9ae90ed7891e4ea1fc678c7a Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 1 Dec 2023 19:16:54 -0500 Subject: [PATCH 04/31] DOC: update changelog Added a summary of changes to the changelog. --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2428eebd..c2cc5e11 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,7 @@ This project adheres to [Semantic Versioning](https://semver.org/). * Changed F10.7 daily test day to ensure new pysat padding tests work * Removed try/except loop that was a fix for pysat < 3.1.0 * Updated 'use_header' kwarg use for pysat 3.2.0 changes + * Updated code headers to include license, reference, and pub release info [0.0.10] - 2023-06-01 --------------------- From 0c83ed99dd06e6513a274025b66b49361f6e61c8 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 9 Jan 2024 14:15:00 -0500 Subject: [PATCH 05/31] DOC: added pub release to docs Added a pub release statement to the online docs. --- docs/index.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 6b5cb9dc..db161e38 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,13 @@ indices as pysat.Instrument objects. history.rst +.. admonition:: DISTRIBUTION STATEMENT A: Approved for public release. + Distribution is unlimited. + + This work was supported by the Office of Naval Research. + + + Indices and tables ================== From cade857a5de0f5c80fea705220894e0536ce7911 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 9 Jan 2024 14:15:16 -0500 Subject: [PATCH 06/31] REL: updated version number Updated the version number in preparation for the release. --- docs/conf.py | 2 +- pyproject.toml | 4 ++-- setup.cfg | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 975bccdd..e35e7b25 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -71,7 +71,7 @@ version = info.project['version'].base_version # The full version, including alpha/beta/rc tags. -release = '{:s}-alpha'.format(version) +release = '{:s}-beta'.format(version) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/pyproject.toml b/pyproject.toml index badab311..aac7c139 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "pysatSpaceWeather" -version = "0.0.10" +version = "0.1.0" description = 'pysat support for Space Weather Indices' readme = "README.md" requires-python = ">=3.6" @@ -13,7 +13,7 @@ authors = [ {name = "Angeline Burrell", email = "pysat.developers@gmail.com"} ] classifiers = [ - "Development Status :: 3 - Alpha", + "Development Status :: 4 - Beta", "Topic :: Scientific/Engineering :: Astronomy", "Topic :: Scientific/Engineering :: Physics", "Topic :: Scientific/Engineering :: Atmospheric Science", diff --git a/setup.cfg b/setup.cfg index a0a8a7ce..3d5d145f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = pysatSpaceWeather -version = 0.0.10 +version = 0.1.0 url = https://github.com/pysat/pysatSpaceWeather [flake8] From 6a357ef7a8461946a90c88060c2e08d2aa91c109 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 16 Jan 2024 11:55:21 -0500 Subject: [PATCH 07/31] MAINT: updated Instrument kwargs Updated Instrument kwargs to apply to all supported pysat versions. --- pysatSpaceWeather/instruments/methods/kp_ap.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/pysatSpaceWeather/instruments/methods/kp_ap.py b/pysatSpaceWeather/instruments/methods/kp_ap.py index 8454ffdb..a4fe1d96 100644 --- a/pysatSpaceWeather/instruments/methods/kp_ap.py +++ b/pysatSpaceWeather/instruments/methods/kp_ap.py @@ -588,12 +588,19 @@ def combine_kp(standard_inst=None, recent_inst=None, forecast_inst=None, "provide starting and ending times"))) # Initialize the output instrument - kp_inst = pysat.Instrument(labels=all_inst[0].meta_labels) + # TODO(#136): Remove if/else when pysat is 3.2.0+ + if hasattr(all_inst[0], "meta_labels"): + meta_kwargs = {"labels": all_inst[0].meta_labels} + kp_inst = pysat.Instrument(labels=all_inst[0].meta_labels) + else: + meta_kwargs = all_inst[0].meta_kwargs + kp_inst = pysat.Instrument(meta_kwargs=meta_kwargs) + kp_inst.inst_module = pysat_sw.instruments.sw_kp kp_inst.tag = tag kp_inst.date = start kp_inst.doy = np.int64(start.strftime("%j")) - kp_inst.meta = pysat.Meta(labels=kp_inst.meta_labels) + kp_inst.meta = pysat.Meta(**meta_kwargs) initialize_kp_metadata(kp_inst.meta, 'Kp', fill_val=fill_val) kp_times = list() From 3a035cc85c29a402a235ac1a6423c60ba0e19159 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 16 Jan 2024 11:57:19 -0500 Subject: [PATCH 08/31] MAINT: removed deprecation warnings Removed deprecation warnings for the new instruments and the supporting tests. --- pysatSpaceWeather/instruments/sw_f107.py | 20 ------ pysatSpaceWeather/instruments/sw_kp.py | 10 --- pysatSpaceWeather/tests/test_instruments.py | 71 +-------------------- 3 files changed, 1 insertion(+), 100 deletions(-) diff --git a/pysatSpaceWeather/instruments/sw_f107.py b/pysatSpaceWeather/instruments/sw_f107.py index 92e33e42..3818989b 100644 --- a/pysatSpaceWeather/instruments/sw_f107.py +++ b/pysatSpaceWeather/instruments/sw_f107.py @@ -136,26 +136,6 @@ def init(self): if self.tag == 'historic': self.lasp_stime = lasp_stime - # Raise Deprecation warnings - if self.tag in ['daily', 'prelim']: - # This tag loads more than just F10.7 data, and the behaviour will be - # deprecated in v0.1.0 - warnings.warn("".join(["Upcoming structural changes will prevent ", - "Instruments from loading multiple data sets in", - " one Instrument. In version 0.1.0+ the SSN, ", - "solar flare, and solar mean field data will be", - " accessable from the `sw_ssn`, `sw_flare`, ", - "and `sw_sbfield` Instruments."]), - DeprecationWarning, stacklevel=2) - elif self.tag == '45day': - # This tag loads more than just F10.7 data, and the behaviour will be - # deprecated in v0.1.0 - warnings.warn("".join(["Upcoming structural changes will prevent ", - "Instruments from loading multiple data sets in", - " one Instrument. In version 0.1.0+ the Ap will", - " be accessable from the `sw_ap` Instrument."]), - DeprecationWarning, stacklevel=2) - return diff --git a/pysatSpaceWeather/instruments/sw_kp.py b/pysatSpaceWeather/instruments/sw_kp.py index 76aadb2f..25d307aa 100644 --- a/pysatSpaceWeather/instruments/sw_kp.py +++ b/pysatSpaceWeather/instruments/sw_kp.py @@ -126,16 +126,6 @@ def init(self): self.references = methods.kp_ap.references(self.name, self.tag) pysat.logger.info(self.acknowledgements) - if self.tag in ["def", "now"]: - # This tag loads more than just Kp data, and the behaviour will be - # deprecated in v0.1.0 - warnings.warn("".join(["Upcoming structural changes will prevent ", - "Instruments from loading multiple data sets ", - "in one Instrument. In version 0.1.0+ the Ap ", - "and Cp data will be accessable from the ", - "`sw_ap` and `sw_cp` Instruments."]), - DeprecationWarning, stacklevel=2) - return diff --git a/pysatSpaceWeather/tests/test_instruments.py b/pysatSpaceWeather/tests/test_instruments.py index 5c572cb5..fb578010 100644 --- a/pysatSpaceWeather/tests/test_instruments.py +++ b/pysatSpaceWeather/tests/test_instruments.py @@ -58,11 +58,7 @@ def setup_method(self): warnings.simplefilter("always", DeprecationWarning) self.in_kwargs = [ - {"inst_module": pysatSpaceWeather.instruments.sw_kp, 'tag': ''}, - {"inst_module": pysatSpaceWeather.instruments.sw_kp}, - {"inst_module": pysatSpaceWeather.instruments.sw_f107, - 'tag': '45day'}, - {"inst_module": pysatSpaceWeather.instruments.sw_f107}] + {"inst_module": pysatSpaceWeather.instruments.sw_kp, 'tag': ''}] self.ref_time = dt.datetime(2001, 1, 1) self.warn_msgs = [] self.war = "" @@ -99,71 +95,6 @@ def test_sw_kp_default_tag_deprecation(self): self.eval_warnings() return - @pytest.mark.parametrize("tag", ["def", "now"]) - def test_sw_kp_gfz_extra_data_deprecation(self, tag): - """Test the deprecation for loading extra data for the GFZ sw_kp data. - - Parameters - ---------- - tag : str - Instrument tag - - """ - - with warnings.catch_warnings(record=True) as self.war: - pysat.Instrument(tag=tag, **self.in_kwargs[1]) - - self.warn_msgs = [ - "".join(["Upcoming structural changes will prevent Instruments ", - "from loading multiple data sets in one Instrument. In ", - "version 0.1.0+ the Ap and Cp data will be accessable ", - "from the `sw_ap` and `sw_cp` Instruments."])] - - # Evaluate the warning output - self.eval_warnings() - return - - def test_sw_f107_45day_extra_data_deprecation(self): - """Test the deprecation for loading extra data by 45day sw_f107.""" - - with warnings.catch_warnings(record=True) as self.war: - pysat.Instrument(**self.in_kwargs[2]) - - self.warn_msgs = ["".join(["Upcoming structural changes will prevent ", - "Instruments from loading multiple data ", - "sets in one Instrument. In version 0.1.0+", - " the Ap will be accessable from the ", - "`sw_ap` Instrument."])] - - # Evaluate the warning output - self.eval_warnings() - return - - @pytest.mark.parametrize("tag", ["daily", "prelim"]) - def test_sw_f107_extra_data_deprecation(self, tag): - """Test the deprecation for loading extra data using SWPC sw_f107 data. - - Parameters - ---------- - tag : str - Instrument tag - - """ - - with warnings.catch_warnings(record=True) as self.war: - pysat.Instrument(tag=tag, **self.in_kwargs[3]) - - self.warn_msgs = [ - "".join(["Upcoming structural changes will prevent Instruments ", - "from loading multiple data sets in one Instrument. In ", - "version 0.1.0+ the SSN, solar flare, and solar mean ", - "field data will be accessable from the `sw_ssn`, ", - "`sw_flare`, and `sw_sbfield` Instruments."])] - - # Evaluate the warning output - self.eval_warnings() - return - class TestSWInstrumentLogging(object): """Test logging messages raised under instrument-specific conditions.""" From ac8503b7d31554353ad4f4fec7847d44d9637f8e Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 16 Jan 2024 13:50:16 -0500 Subject: [PATCH 09/31] STY: remove unused import Remove warnings module, as it is no longer used. --- pysatSpaceWeather/instruments/sw_f107.py | 1 - 1 file changed, 1 deletion(-) diff --git a/pysatSpaceWeather/instruments/sw_f107.py b/pysatSpaceWeather/instruments/sw_f107.py index 3818989b..754fbe45 100644 --- a/pysatSpaceWeather/instruments/sw_f107.py +++ b/pysatSpaceWeather/instruments/sw_f107.py @@ -73,7 +73,6 @@ import numpy as np import os import pandas as pds -import warnings import pysat From ede7755e6bf20b3f45084b0ee3002c5b3ec3feae Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 16 Jan 2024 13:50:35 -0500 Subject: [PATCH 10/31] TST: update theme versions Update the RTD theme limits. --- test_requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/test_requirements.txt b/test_requirements.txt index b8a41858..3bfdc26d 100644 --- a/test_requirements.txt +++ b/test_requirements.txt @@ -7,4 +7,4 @@ numpydoc pytest-cov pytest-ordering sphinx -sphinx_rtd_theme +sphinx_rtd_theme>=1.2.2,<2.0.0 From b97adc5956328c71440bd5cd0fe6cc34c14cb3a2 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 16 Jan 2024 13:54:58 -0500 Subject: [PATCH 11/31] TST: update test modules Update test module version in the pyproject.toml. --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index aac7c139..59a3b31d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -65,7 +65,7 @@ doc = [ "numpydoc", "pyproject_parser", "sphinx", - "sphinx_rtd_theme >= 1.2.2" + "sphinx_rtd_theme >= 1.2.2,<2.0.0" ] [project.urls] From 687d3ea74dbaf0fbd34212f0dfe87ef830cbd999 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 19 Jan 2024 10:27:01 -0500 Subject: [PATCH 12/31] BUG: remove unneeded if Removed an if statement that caused test failure. --- .github/workflows/pysat_rc.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/pysat_rc.yml b/.github/workflows/pysat_rc.yml index 84b7d83b..480bb7c4 100644 --- a/.github/workflows/pysat_rc.yml +++ b/.github/workflows/pysat_rc.yml @@ -27,7 +27,6 @@ jobs: run: pip install --no-deps --pre -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pysat - name: Install standard dependencies and package - if: ${{ matrix.test_config == 'latest'}} run: pip install .[test] - name: Set up pysat From 456ce47d1fa82b1f7c2cffb2ee5ed7339ccd52ac Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 24 Jan 2024 09:25:15 -0500 Subject: [PATCH 13/31] MAINT: grammar fixes Made grammar fixes suggested in code review. Co-authored-by: Russell Stoneback --- CHANGELOG.md | 2 +- docs/supported_instruments.rst | 14 +++++++------- pysatSpaceWeather/instruments/methods/ace.py | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c2cc5e11..9d717278 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ This project adheres to [Semantic Versioning](https://semver.org/). [0.1.0] - 2023-XX-XX -------------------- * Enhancements - * Changed downloads to write files across multiple Instruments, when the + * Changed downloads to write files across multiple Instruments when the remote files contain a mix of data products * Added new instruments: sw_ae, sw_al, sw_au, sw_ap, sw_apo, sw_cp, sw_flare, sw_hpo, sw_polar-cap, sw_sbfield, sw_ssn, and sw_storm-prob diff --git a/docs/supported_instruments.rst b/docs/supported_instruments.rst index 69cec7fd..efb508a6 100644 --- a/docs/supported_instruments.rst +++ b/docs/supported_instruments.rst @@ -84,7 +84,7 @@ AE ^^^ AE is an auroral electrojet index that reflects the level of magnetic deflection -in the auroral zone, due to the difference between the eastward and westward +in the auroral zone due to the difference between the eastward and westward electroject currents at Earth. Real-time predictions (last 96 hours) are provided by `LASP `_. @@ -132,7 +132,7 @@ Ap ^^^ Ap is a geomagnetic index that reflects the magnitude of geomagnetic -disturbances at Earth, but unlike the Kp uses a linear scale. Historic, recent +disturbances at Earth but unlike Kp uses a linear scale. Historic, recent (last 30 days), and forecasted values are available from `GFZ `_ and the `SWPC Forecasts page `_. @@ -148,7 +148,7 @@ apo ^^^ apo is a linear (half)-hourly, planetary, open-ended, geomagnetic index that -reflects the magnitude of geomagnetic disturbances at Earth. It is like Ap, but +reflects the magnitude of geomagnetic disturbances at Earth. It is like Ap but does not have an upper limit. Values from 1995 onwards are available from `GFZ `_. @@ -214,7 +214,7 @@ Historic indices, real-time indices, and forecasted indices are available from Solar Flares ^^^^^^^^^^^^ -Solar flares have been monitored for decades, and the data has been compiled +Solar flares have been monitored for decades and the data has been compiled into standard measurements from different data sets. Historic indices, real-time indices, and forecasted indices are available from `SWPC `_. @@ -229,8 +229,8 @@ real-time indices, and forecasted indices are available from Hpo ^^^ -Hpo is a (half)-Hourly, Planetary, Open-ended, geomagnetic index that -reflects the magnitude of geomagnetic disturbances at Earth. It is like Kp, but +Hpo is a (half)-Hourly, planetary, open-ended, geomagnetic index that +reflects the magnitude of geomagnetic disturbances at Earth. It is like Kp but does not have an upper limit. Values from 1995 onwards are available from `GFZ `_. @@ -276,7 +276,7 @@ Polar Cap Polar cap indices have been developed to provide information about high-latitude conditions and inform ionospheric space weather models. Currently, this -Instrument provides absorption predictions from SWPC. +:py:class:`~pysat._instrument.Instrument` provides absorption predictions from SWPC. .. automodule:: pysatSpaceWeather.instruments.sw_polarcap :members: diff --git a/pysatSpaceWeather/instruments/methods/ace.py b/pysatSpaceWeather/instruments/methods/ace.py index 4f52ed71..ef1695c4 100644 --- a/pysatSpaceWeather/instruments/methods/ace.py +++ b/pysatSpaceWeather/instruments/methods/ace.py @@ -216,7 +216,7 @@ def download(date_array, name, tag='', inst_id='', data_path='', now=None, date_array[0].day != now.day]): logger.warning(''.join(['real-time data only available for current', ' day, data in this file will have the ', - 'wrong date'])) + 'wrong date.'])) else: data_rate = 1 if name in ['mag', 'swepam'] else 5 file_fmt = '_'.join(["%Y%m%d", "ace", name, From 71bb58e05a2c03b60c3628125b242e974d307682 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 24 Jan 2024 12:55:10 -0500 Subject: [PATCH 14/31] MAINT: updated NEP Updated NEP and classifiers. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com> --- .github/workflows/main.yml | 2 +- pyproject.toml | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 6d132627..2ada2185 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -22,7 +22,7 @@ jobs: include: # NEP29 compliance settings - python-version: "3.9" - numpy_ver: "1.21" + numpy_ver: "1.23" os: ubuntu-latest test_config: "NEP29" # Operational compliance settings diff --git a/pyproject.toml b/pyproject.toml index 59a3b31d..d60bf564 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -22,7 +22,6 @@ classifiers = [ "Natural Language :: English", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", - "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", From c5995ee5ca10b3edcfc79fe6d596cf521c4dbc00 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 26 Jan 2024 18:21:35 -0500 Subject: [PATCH 15/31] MAINT: added review suggestions Added more pytest markers and made grammar updates. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com> --- pysatSpaceWeather/instruments/methods/swpc.py | 2 +- pysatSpaceWeather/instruments/sw_dst.py | 4 ++-- pysatSpaceWeather/instruments/sw_hpo.py | 4 ++-- pysatSpaceWeather/instruments/sw_mgii.py | 2 +- pysatSpaceWeather/instruments/sw_polarcap.py | 2 +- pysatSpaceWeather/instruments/sw_sbfield.py | 2 +- pysatSpaceWeather/instruments/sw_ssn.py | 4 ++-- pysatSpaceWeather/instruments/sw_stormprob.py | 2 +- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/pysatSpaceWeather/instruments/methods/swpc.py b/pysatSpaceWeather/instruments/methods/swpc.py index f5df5492..62581225 100644 --- a/pysatSpaceWeather/instruments/methods/swpc.py +++ b/pysatSpaceWeather/instruments/methods/swpc.py @@ -41,7 +41,7 @@ def daily_dsd_download(name, today, data_path, mock_download_dir=None): name : str Instrument name, expects one of 'f107', 'flare', 'ssn', or 'sbfield'. today : dt.datetime - Datetime for current day + Datetime for current day. data_path : str Path to data directory. mock_download_dir : str or NoneType diff --git a/pysatSpaceWeather/instruments/sw_dst.py b/pysatSpaceWeather/instruments/sw_dst.py index a9325b36..87c9b031 100644 --- a/pysatSpaceWeather/instruments/sw_dst.py +++ b/pysatSpaceWeather/instruments/sw_dst.py @@ -263,11 +263,11 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): data_path : str Path to data directory. If not None, will process any files with the correct name and date - as if they were downloaded + as if they were downloaded. mock_download_dir : str or NoneType Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were - downloaded (default=None) + downloaded. (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_hpo.py b/pysatSpaceWeather/instruments/sw_hpo.py index 758c4221..fd878ff3 100644 --- a/pysatSpaceWeather/instruments/sw_hpo.py +++ b/pysatSpaceWeather/instruments/sw_hpo.py @@ -91,9 +91,9 @@ def load(fnames, tag='', inst_id=''): Parameters ---------- fnames : pandas.Series - Series of filenames + Series of filenames. tag : str - Instrument tag (default='') + Instrument tag. (default='') inst_id : str Instrument ID, not used. (default='') diff --git a/pysatSpaceWeather/instruments/sw_mgii.py b/pysatSpaceWeather/instruments/sw_mgii.py index a9e2831e..5d5471b8 100644 --- a/pysatSpaceWeather/instruments/sw_mgii.py +++ b/pysatSpaceWeather/instruments/sw_mgii.py @@ -275,7 +275,7 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): mock_download_dir : str or NoneType Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were - downloaded (default=None) + downloaded. (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_polarcap.py b/pysatSpaceWeather/instruments/sw_polarcap.py index e55abd7c..69dc15ee 100644 --- a/pysatSpaceWeather/instruments/sw_polarcap.py +++ b/pysatSpaceWeather/instruments/sw_polarcap.py @@ -177,7 +177,7 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): mock_download_dir : str or NoneType Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were - downloaded (default=None) + downloaded. (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_sbfield.py b/pysatSpaceWeather/instruments/sw_sbfield.py index c1361ed9..e2a50184 100644 --- a/pysatSpaceWeather/instruments/sw_sbfield.py +++ b/pysatSpaceWeather/instruments/sw_sbfield.py @@ -252,7 +252,7 @@ def download(date_array, tag, inst_id, data_path, update_files=False, mock_download_dir : str or NoneType Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were - downloaded (default=None) + downloaded. (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_ssn.py b/pysatSpaceWeather/instruments/sw_ssn.py index c70d7f74..43244ff2 100644 --- a/pysatSpaceWeather/instruments/sw_ssn.py +++ b/pysatSpaceWeather/instruments/sw_ssn.py @@ -284,11 +284,11 @@ def download(date_array, tag, inst_id, data_path, update_files=False, data_path : str Path to data directory. update_files : bool - Re-download data for files that already exist if True (default=False) + Re-download data for files that already exist if True. (default=False) mock_download_dir : str or NoneType Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were - downloaded (default=None) + downloaded. (default=None) Raises ------ diff --git a/pysatSpaceWeather/instruments/sw_stormprob.py b/pysatSpaceWeather/instruments/sw_stormprob.py index 345866d0..dab7d23a 100644 --- a/pysatSpaceWeather/instruments/sw_stormprob.py +++ b/pysatSpaceWeather/instruments/sw_stormprob.py @@ -178,7 +178,7 @@ def download(date_array, tag, inst_id, data_path, mock_download_dir=None): mock_download_dir : str or NoneType Local directory with downloaded files or None. If not None, will process any files with the correct name and date as if they were - downloaded (default=None) + downloaded. (default=None) Raises ------ From 122373f6f86d623ec1ddbfa592e4e1b772313be5 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Tue, 30 Jan 2024 11:20:11 -0500 Subject: [PATCH 16/31] MAINT: applying some review comments Addressing more of the reviewer comments. Co-authored-by: Russell Stoneback Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com> --- pysatSpaceWeather/instruments/methods/swpc.py | 4 ++-- pysatSpaceWeather/instruments/sw_cp.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/pysatSpaceWeather/instruments/methods/swpc.py b/pysatSpaceWeather/instruments/methods/swpc.py index 62581225..a7ac0858 100644 --- a/pysatSpaceWeather/instruments/methods/swpc.py +++ b/pysatSpaceWeather/instruments/methods/swpc.py @@ -584,7 +584,7 @@ def geomag_forecast_download(name, date_array, data_path, Raises ------ IOError - If an unknown mock download directory is supplied or the desored file + If an unknown mock download directory is supplied or the desired file is missing. Note @@ -958,7 +958,7 @@ def list_files(name, tag, inst_id, data_path, format_str=None): # Pad list of files data to include most recent file under tomorrow if not files.empty: - pds_offset = pds.DateOffset(days=1) + pds_offset = dt.timedelta(days=1) files.loc[files.index[-1] + pds_offset] = files.values[-1] files.loc[files.index[-1] + pds_offset] = files.values[-1] diff --git a/pysatSpaceWeather/instruments/sw_cp.py b/pysatSpaceWeather/instruments/sw_cp.py index f2788bf6..6d2207da 100644 --- a/pysatSpaceWeather/instruments/sw_cp.py +++ b/pysatSpaceWeather/instruments/sw_cp.py @@ -101,9 +101,9 @@ def load(fnames, tag='', inst_id=''): Parameters ---------- fnames : pandas.Series - Series of filenames + Series of filenames. tag : str - Instrument tag (default='') + Instrument tag. (default='') inst_id : str Instrument ID, not used. (default='') From e0e081a4d533bbe413110673dd843dd74f05521f Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 31 Jan 2024 12:03:31 -0500 Subject: [PATCH 17/31] ENH: added acknowledgements file Added an acknowledgements file to the main directory and the docs. --- ACKNOWLEDGEMENTS.md | 23 +++++++++++++++++++++++ docs/acknowledgements.rst | 1 + docs/index.rst | 3 +-- 3 files changed, 25 insertions(+), 2 deletions(-) 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..a7323a5a --- /dev/null +++ b/ACKNOWLEDGEMENTS.md @@ -0,0 +1,23 @@ +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 + - Office of Naval Research (ONR) + - National Aeronautics and Space Administration (NASA) + - National Science Foundation (NSF) + +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. 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 db161e38..c9275979 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,13 +19,12 @@ indices as pysat.Instrument objects. examples.rst develop_guide.rst history.rst + acknowledgements.rst .. admonition:: DISTRIBUTION STATEMENT A: Approved for public release. Distribution is unlimited. - This work was supported by the Office of Naval Research. - Indices and tables From 664370b14380c2aa7408bcad40ad060cc016de37 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 31 Jan 2024 12:03:52 -0500 Subject: [PATCH 18/31] DOC: updated the changelog Added a summary of the changes to the changelog. --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d717278..a1bed077 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ This project adheres to [Semantic Versioning](https://semver.org/). * Added new examples to the documentation * Added new test attributes for clean messages to the ACE instruments * Added the ability to 'download' files from a local directory + * Added an acknowledgements file with detailed funding information * Maintenance * Updated package documentation, yamls, and other supporting files * Updated the LISIRD download routine to reflect new behaviour From 9f188e8c3bb5ad7d2ee2b67e4ecfd7b2366a3549 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 31 Jan 2024 12:04:12 -0500 Subject: [PATCH 19/31] DOC: updated file headers Updated the file headers to remove funding information. --- pysatSpaceWeather/instruments/ace_epam.py | 1 - pysatSpaceWeather/instruments/ace_mag.py | 1 - pysatSpaceWeather/instruments/ace_sis.py | 1 - pysatSpaceWeather/instruments/ace_swepam.py | 1 - pysatSpaceWeather/instruments/methods/ace.py | 1 - .../instruments/methods/auroral_electrojet.py | 1 - pysatSpaceWeather/instruments/methods/dst.py | 1 - pysatSpaceWeather/instruments/methods/f107.py | 1 - pysatSpaceWeather/instruments/methods/general.py | 1 - pysatSpaceWeather/instruments/methods/gfz.py | 1 - pysatSpaceWeather/instruments/methods/kp_ap.py | 1 - pysatSpaceWeather/instruments/methods/lasp.py | 1 - pysatSpaceWeather/instruments/methods/lisird.py | 1 - pysatSpaceWeather/instruments/methods/swpc.py | 1 - pysatSpaceWeather/instruments/sw_ae.py | 1 - pysatSpaceWeather/instruments/sw_al.py | 1 - pysatSpaceWeather/instruments/sw_ap.py | 1 - pysatSpaceWeather/instruments/sw_apo.py | 1 - pysatSpaceWeather/instruments/sw_au.py | 1 - pysatSpaceWeather/instruments/sw_cp.py | 1 - pysatSpaceWeather/instruments/sw_dst.py | 8 -------- pysatSpaceWeather/instruments/sw_f107.py | 1 - pysatSpaceWeather/instruments/sw_flare.py | 1 - pysatSpaceWeather/instruments/sw_hpo.py | 1 - pysatSpaceWeather/instruments/sw_kp.py | 8 -------- pysatSpaceWeather/instruments/sw_mgii.py | 1 - pysatSpaceWeather/instruments/sw_polarcap.py | 1 - pysatSpaceWeather/instruments/sw_sbfield.py | 1 - pysatSpaceWeather/instruments/sw_ssn.py | 1 - pysatSpaceWeather/instruments/sw_stormprob.py | 1 - pysatSpaceWeather/tests/test_instruments.py | 1 - pysatSpaceWeather/tests/test_methods_ace.py | 1 - pysatSpaceWeather/tests/test_methods_ae.py | 1 - pysatSpaceWeather/tests/test_methods_f107.py | 1 - pysatSpaceWeather/tests/test_methods_general.py | 1 - pysatSpaceWeather/tests/test_methods_gfz.py | 1 - pysatSpaceWeather/tests/test_methods_kp.py | 1 - pysatSpaceWeather/tests/test_methods_lisird.py | 1 - 38 files changed, 52 deletions(-) diff --git a/pysatSpaceWeather/instruments/ace_epam.py b/pysatSpaceWeather/instruments/ace_epam.py index 171e069d..ae439c6c 100644 --- a/pysatSpaceWeather/instruments/ace_epam.py +++ b/pysatSpaceWeather/instruments/ace_epam.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports ACE Electron, Proton, and Alpha Monitor data. diff --git a/pysatSpaceWeather/instruments/ace_mag.py b/pysatSpaceWeather/instruments/ace_mag.py index f8529708..27e82fbd 100644 --- a/pysatSpaceWeather/instruments/ace_mag.py +++ b/pysatSpaceWeather/instruments/ace_mag.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports ACE Magnetometer data. diff --git a/pysatSpaceWeather/instruments/ace_sis.py b/pysatSpaceWeather/instruments/ace_sis.py index 1c8a5a7c..61f6546a 100644 --- a/pysatSpaceWeather/instruments/ace_sis.py +++ b/pysatSpaceWeather/instruments/ace_sis.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports ACE Solar Isotope Spectrometer data. diff --git a/pysatSpaceWeather/instruments/ace_swepam.py b/pysatSpaceWeather/instruments/ace_swepam.py index 3388d6d2..174d4245 100644 --- a/pysatSpaceWeather/instruments/ace_swepam.py +++ b/pysatSpaceWeather/instruments/ace_swepam.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports ACE Solar Wind Electron Proton Alpha Monitor data. diff --git a/pysatSpaceWeather/instruments/methods/ace.py b/pysatSpaceWeather/instruments/methods/ace.py index ef1695c4..83f756fa 100644 --- a/pysatSpaceWeather/instruments/methods/ace.py +++ b/pysatSpaceWeather/instruments/methods/ace.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides general routines for the ACE space weather instruments.""" diff --git a/pysatSpaceWeather/instruments/methods/auroral_electrojet.py b/pysatSpaceWeather/instruments/methods/auroral_electrojet.py index 91864507..2c0b179d 100644 --- a/pysatSpaceWeather/instruments/methods/auroral_electrojet.py +++ b/pysatSpaceWeather/instruments/methods/auroral_electrojet.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides support routines for auroral electrojet indices.""" diff --git a/pysatSpaceWeather/instruments/methods/dst.py b/pysatSpaceWeather/instruments/methods/dst.py index ac062a51..b4831a64 100644 --- a/pysatSpaceWeather/instruments/methods/dst.py +++ b/pysatSpaceWeather/instruments/methods/dst.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides default routines for Dst.""" diff --git a/pysatSpaceWeather/instruments/methods/f107.py b/pysatSpaceWeather/instruments/methods/f107.py index 1e5278d1..3fe7edf7 100644 --- a/pysatSpaceWeather/instruments/methods/f107.py +++ b/pysatSpaceWeather/instruments/methods/f107.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Routines for the F10.7 solar index.""" diff --git a/pysatSpaceWeather/instruments/methods/general.py b/pysatSpaceWeather/instruments/methods/general.py index 9bdff66b..eccccbeb 100644 --- a/pysatSpaceWeather/instruments/methods/general.py +++ b/pysatSpaceWeather/instruments/methods/general.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides routines that support general space weather instruments.""" diff --git a/pysatSpaceWeather/instruments/methods/gfz.py b/pysatSpaceWeather/instruments/methods/gfz.py index 53ca3e35..12ffcebb 100644 --- a/pysatSpaceWeather/instruments/methods/gfz.py +++ b/pysatSpaceWeather/instruments/methods/gfz.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides routines that support GFZ space weather instruments.""" diff --git a/pysatSpaceWeather/instruments/methods/kp_ap.py b/pysatSpaceWeather/instruments/methods/kp_ap.py index a4fe1d96..efc2eec0 100644 --- a/pysatSpaceWeather/instruments/methods/kp_ap.py +++ b/pysatSpaceWeather/instruments/methods/kp_ap.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides routines to support the geomagnetic indices, Kp and Ap.""" diff --git a/pysatSpaceWeather/instruments/methods/lasp.py b/pysatSpaceWeather/instruments/methods/lasp.py index 98fdd709..a3ddfaf0 100644 --- a/pysatSpaceWeather/instruments/methods/lasp.py +++ b/pysatSpaceWeather/instruments/methods/lasp.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides support routines for LASP data.""" diff --git a/pysatSpaceWeather/instruments/methods/lisird.py b/pysatSpaceWeather/instruments/methods/lisird.py index 48e819a5..58327499 100644 --- a/pysatSpaceWeather/instruments/methods/lisird.py +++ b/pysatSpaceWeather/instruments/methods/lisird.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides support functions for the LASP LISIRD data base.""" diff --git a/pysatSpaceWeather/instruments/methods/swpc.py b/pysatSpaceWeather/instruments/methods/swpc.py index a7ac0858..0635a599 100644 --- a/pysatSpaceWeather/instruments/methods/swpc.py +++ b/pysatSpaceWeather/instruments/methods/swpc.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Provides routines that support SWPC space weather instruments.""" diff --git a/pysatSpaceWeather/instruments/sw_ae.py b/pysatSpaceWeather/instruments/sw_ae.py index a5e63b23..73d2db43 100644 --- a/pysatSpaceWeather/instruments/sw_ae.py +++ b/pysatSpaceWeather/instruments/sw_ae.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports the auroral electrojet AE values. diff --git a/pysatSpaceWeather/instruments/sw_al.py b/pysatSpaceWeather/instruments/sw_al.py index eff8c377..72f07ed5 100644 --- a/pysatSpaceWeather/instruments/sw_al.py +++ b/pysatSpaceWeather/instruments/sw_al.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports the auroral electrojet AL values. diff --git a/pysatSpaceWeather/instruments/sw_ap.py b/pysatSpaceWeather/instruments/sw_ap.py index dc26c129..147ca5fa 100644 --- a/pysatSpaceWeather/instruments/sw_ap.py +++ b/pysatSpaceWeather/instruments/sw_ap.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports ap index values. diff --git a/pysatSpaceWeather/instruments/sw_apo.py b/pysatSpaceWeather/instruments/sw_apo.py index 0357bfb1..be5f139e 100644 --- a/pysatSpaceWeather/instruments/sw_apo.py +++ b/pysatSpaceWeather/instruments/sw_apo.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports apo index values. diff --git a/pysatSpaceWeather/instruments/sw_au.py b/pysatSpaceWeather/instruments/sw_au.py index 392fca5f..4c490855 100644 --- a/pysatSpaceWeather/instruments/sw_au.py +++ b/pysatSpaceWeather/instruments/sw_au.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports the auroral electrojet AU values. diff --git a/pysatSpaceWeather/instruments/sw_cp.py b/pysatSpaceWeather/instruments/sw_cp.py index 6d2207da..009e9f05 100644 --- a/pysatSpaceWeather/instruments/sw_cp.py +++ b/pysatSpaceWeather/instruments/sw_cp.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports Cp index values. diff --git a/pysatSpaceWeather/instruments/sw_dst.py b/pysatSpaceWeather/instruments/sw_dst.py index 87c9b031..6d6fc407 100644 --- a/pysatSpaceWeather/instruments/sw_dst.py +++ b/pysatSpaceWeather/instruments/sw_dst.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports Dst values. Downloads data from NGDC. @@ -26,13 +25,6 @@ ---- Will only work until 2057. -This material is based upon work supported by the -National Science Foundation under Grant Number 1259508. - -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 National Science Foundation. - """ import datetime as dt diff --git a/pysatSpaceWeather/instruments/sw_f107.py b/pysatSpaceWeather/instruments/sw_f107.py index 754fbe45..53854ebb 100644 --- a/pysatSpaceWeather/instruments/sw_f107.py +++ b/pysatSpaceWeather/instruments/sw_f107.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports F10.7 index values. diff --git a/pysatSpaceWeather/instruments/sw_flare.py b/pysatSpaceWeather/instruments/sw_flare.py index 83d3da45..54bd1470 100644 --- a/pysatSpaceWeather/instruments/sw_flare.py +++ b/pysatSpaceWeather/instruments/sw_flare.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports solar flare values. diff --git a/pysatSpaceWeather/instruments/sw_hpo.py b/pysatSpaceWeather/instruments/sw_hpo.py index fd878ff3..9db5a1cf 100644 --- a/pysatSpaceWeather/instruments/sw_hpo.py +++ b/pysatSpaceWeather/instruments/sw_hpo.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports Hpo index values. diff --git a/pysatSpaceWeather/instruments/sw_kp.py b/pysatSpaceWeather/instruments/sw_kp.py index 25d307aa..030b93b9 100644 --- a/pysatSpaceWeather/instruments/sw_kp.py +++ b/pysatSpaceWeather/instruments/sw_kp.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports Kp index values. @@ -65,13 +64,6 @@ feature, and multi_file_day feature available from the pyast.Instrument object is not appropriate for these tags data. -This material is based upon work supported by the -National Science Foundation under Grant Number 1259508. - -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 National Science Foundation. - """ import datetime as dt diff --git a/pysatSpaceWeather/instruments/sw_mgii.py b/pysatSpaceWeather/instruments/sw_mgii.py index 5d5471b8..c624a196 100644 --- a/pysatSpaceWeather/instruments/sw_mgii.py +++ b/pysatSpaceWeather/instruments/sw_mgii.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports the MgII core-to-wing ratio index. diff --git a/pysatSpaceWeather/instruments/sw_polarcap.py b/pysatSpaceWeather/instruments/sw_polarcap.py index 69dc15ee..9a85df01 100644 --- a/pysatSpaceWeather/instruments/sw_polarcap.py +++ b/pysatSpaceWeather/instruments/sw_polarcap.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports polar cap indexes. diff --git a/pysatSpaceWeather/instruments/sw_sbfield.py b/pysatSpaceWeather/instruments/sw_sbfield.py index e2a50184..f4207f41 100644 --- a/pysatSpaceWeather/instruments/sw_sbfield.py +++ b/pysatSpaceWeather/instruments/sw_sbfield.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports solar magnetic field values. diff --git a/pysatSpaceWeather/instruments/sw_ssn.py b/pysatSpaceWeather/instruments/sw_ssn.py index 43244ff2..77eafba2 100644 --- a/pysatSpaceWeather/instruments/sw_ssn.py +++ b/pysatSpaceWeather/instruments/sw_ssn.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports Sunspot Number (SSN) and related indices. diff --git a/pysatSpaceWeather/instruments/sw_stormprob.py b/pysatSpaceWeather/instruments/sw_stormprob.py index dab7d23a..1dea8079 100644 --- a/pysatSpaceWeather/instruments/sw_stormprob.py +++ b/pysatSpaceWeather/instruments/sw_stormprob.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Supports storm probabilities. diff --git a/pysatSpaceWeather/tests/test_instruments.py b/pysatSpaceWeather/tests/test_instruments.py index fb578010..ac685c45 100644 --- a/pysatSpaceWeather/tests/test_instruments.py +++ b/pysatSpaceWeather/tests/test_instruments.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Unit and Integration Tests for each instrument module. diff --git a/pysatSpaceWeather/tests/test_methods_ace.py b/pysatSpaceWeather/tests/test_methods_ace.py index 52f982df..41be5173 100644 --- a/pysatSpaceWeather/tests/test_methods_ace.py +++ b/pysatSpaceWeather/tests/test_methods_ace.py @@ -5,7 +5,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Integration and unit test suite for ACE methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_ae.py b/pysatSpaceWeather/tests/test_methods_ae.py index d9339e5b..705330ed 100644 --- a/pysatSpaceWeather/tests/test_methods_ae.py +++ b/pysatSpaceWeather/tests/test_methods_ae.py @@ -5,7 +5,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Integration and unit test suite for AE methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_f107.py b/pysatSpaceWeather/tests/test_methods_f107.py index d35910c2..30bc16e5 100644 --- a/pysatSpaceWeather/tests/test_methods_f107.py +++ b/pysatSpaceWeather/tests/test_methods_f107.py @@ -5,7 +5,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Test suite for F10.7 methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_general.py b/pysatSpaceWeather/tests/test_methods_general.py index da244760..bc7db985 100644 --- a/pysatSpaceWeather/tests/test_methods_general.py +++ b/pysatSpaceWeather/tests/test_methods_general.py @@ -5,7 +5,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Integration and unit test suite for ACE methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_gfz.py b/pysatSpaceWeather/tests/test_methods_gfz.py index cae7b50a..c3954336 100644 --- a/pysatSpaceWeather/tests/test_methods_gfz.py +++ b/pysatSpaceWeather/tests/test_methods_gfz.py @@ -5,7 +5,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Integration and unit test suite for ACE methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_kp.py b/pysatSpaceWeather/tests/test_methods_kp.py index 8cfbacf5..9f10e3c1 100644 --- a/pysatSpaceWeather/tests/test_methods_kp.py +++ b/pysatSpaceWeather/tests/test_methods_kp.py @@ -5,7 +5,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Test suite for Kp and Ap methods.""" diff --git a/pysatSpaceWeather/tests/test_methods_lisird.py b/pysatSpaceWeather/tests/test_methods_lisird.py index 77018a18..75a2c397 100644 --- a/pysatSpaceWeather/tests/test_methods_lisird.py +++ b/pysatSpaceWeather/tests/test_methods_lisird.py @@ -6,7 +6,6 @@ # # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is # unlimited. -# This work was supported by the Office of Naval Research. # ---------------------------------------------------------------------------- """Tests for the LISIRD functions.""" From 1ce79906edb9d88b4957244cc7ff2fa2a4357c03 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 31 Jan 2024 15:26:58 -0500 Subject: [PATCH 20/31] DOC: Update ACKNOWLEDGEMENTS.md Updated Jeff's contributions. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com> --- ACKNOWLEDGEMENTS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index a7323a5a..c6e5a876 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -15,6 +15,7 @@ Programs -------- - NSF 125908, AGS-1651393 - Naval Research Laboratory N00173191G016 and N0017322P0744 + - The Space Precipitation Impacts (SPI) project at Goddard Space Flight Center through the Heliophysics Internal Science Funding Model Disclaimers =========== From 080ecf4541a146d516f7cb62b95cfa5964ce6ef6 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 31 Jan 2024 15:37:23 -0500 Subject: [PATCH 21/31] ENH: updated pyproject.toml Updated the pytest codes for future pysat compatibility. Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com> --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index d60bf564..80bd9d32 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -80,6 +80,7 @@ markers = [ "download", "no_download", "load_options", + "new_tests", "first", "second" ] From 8aa7ea71bd97e2e8165ebac0c10a02e0205ea705 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 31 Jan 2024 16:53:49 -0500 Subject: [PATCH 22/31] DOC: update acknowledgements Put institutions in alphabetical order and add CUA for Jonathan. --- ACKNOWLEDGEMENTS.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index c6e5a876..3d23c705 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -5,11 +5,12 @@ for pysatSpaceWeather development. Institutions ------------ + - Catholic University of America (CUA) - Cosmic Studio - Defense Advanced Research Projects Agency (DARPA) Defense Sciences Office - - Office of Naval Research (ONR) - National Aeronautics and Space Administration (NASA) - National Science Foundation (NSF) + - Office of Naval Research (ONR) Programs -------- From 2b5f7e1fc008d1da63f74e2966c48f38714a66cb Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 1 Feb 2024 11:04:08 -0500 Subject: [PATCH 23/31] MAINT: Update ACKNOWLEDGEMENTS.md Add article to institution name. Co-authored-by: Russell Stoneback --- ACKNOWLEDGEMENTS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index 3d23c705..1aa5a0d3 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -5,7 +5,7 @@ for pysatSpaceWeather development. Institutions ------------ - - Catholic University of America (CUA) + - The Catholic University of America (CUA) - Cosmic Studio - Defense Advanced Research Projects Agency (DARPA) Defense Sciences Office - National Aeronautics and Space Administration (NASA) From 38f098b0a07c2fc890349c273776cdb229a54e6c Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 1 Feb 2024 14:34:10 -0500 Subject: [PATCH 24/31] MAINT: updated classifiers Updated the python version classifiers. --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 80bd9d32..9d75a5e0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,6 +25,7 @@ classifiers = [ "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", "Operating System :: POSIX :: Linux", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows" From c42eff7da9d9e1f20aacd0c7a947c2311a13310c Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 1 Feb 2024 14:35:14 -0500 Subject: [PATCH 25/31] DOC: updated installation instructions Updated the installation instructions in the docs and the README. --- README.md | 3 ++- docs/installation.rst | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c28ab292..88f51490 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,8 @@ a local install use the "--user" flag after "install". ``` cd pysatSpaceWeather/ -python setup.py install +python -m build . +pip install . ``` # Examples diff --git a/docs/installation.rst b/docs/installation.rst index 748d3e32..35c0eda9 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -19,7 +19,7 @@ Prerequisites pysatSpaceWeather uses common Python modules, as well as modules developed by and for the Space Physics community. This module officially supports -Python 3.7+. +Python 3.6 and 3.9+. ============== ================= Common modules Community modules From 0a933df57daca752df903c120c6515663b39dfc6 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 1 Feb 2024 14:35:44 -0500 Subject: [PATCH 26/31] TST: updated CI versions Added python 3.12 to the testing and updated the action versions used. --- .github/workflows/docs.yml | 6 +++--- .github/workflows/main.yml | 6 +++--- .github/workflows/pip_rc_install.yml | 6 +++--- .github/workflows/pysat_rc.yml | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3d9f3988..3522b6c3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -13,13 +13,13 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.10"] + python-version: ["3.11"] name: Documentation tests steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 2ada2185..d6efa7db 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -16,7 +16,7 @@ jobs: fail-fast: false matrix: os: ["ubuntu-latest", "macos-latest", "windows-latest"] - python-version: ["3.10", "3.11"] + python-version: ["3.10", "3.11", "3.12"] numpy_ver: ["latest"] test_config: ["latest"] include: @@ -34,9 +34,9 @@ jobs: name: Python ${{ matrix.python-version }} on ${{ matrix.os }} with numpy ${{ matrix.numpy_ver }} runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} diff --git a/.github/workflows/pip_rc_install.yml b/.github/workflows/pip_rc_install.yml index 1cbfe441..322ed53b 100644 --- a/.github/workflows/pip_rc_install.yml +++ b/.github/workflows/pip_rc_install.yml @@ -13,14 +13,14 @@ jobs: fail-fast: false matrix: os: ["ubuntu-latest", "macos-latest", "windows-latest"] - python-version: ["3.11"] # Keep this version at the highest supported Python version + python-version: ["3.12"] # Keep this version at the highest supported Python version name: Python ${{ matrix.python-version }} on ${{ matrix.os }} runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} diff --git a/.github/workflows/pysat_rc.yml b/.github/workflows/pysat_rc.yml index 480bb7c4..ec5b3174 100644 --- a/.github/workflows/pysat_rc.yml +++ b/.github/workflows/pysat_rc.yml @@ -12,14 +12,14 @@ jobs: fail-fast: false matrix: os: ["ubuntu-latest", "macos-latest", "windows-latest"] - python-version: ["3.10"] + python-version: ["3.11"] name: Python ${{ matrix.python-version }} on ${{ matrix.os }} runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v4 + uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} From 648789d85e9e819d4a5dd5198149e81532e95b5d Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 1 Feb 2024 14:36:03 -0500 Subject: [PATCH 27/31] DOC: update changelog Update the changelog to include the python version bump. --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9d717278..3948c4cf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ This project adheres to [Semantic Versioning](https://semver.org/). * Removed try/except loop that was a fix for pysat < 3.1.0 * Updated 'use_header' kwarg use for pysat 3.2.0 changes * Updated code headers to include license, reference, and pub release info + * Updated the supported python versions [0.0.10] - 2023-06-01 --------------------- From 587ae422464b08a4903335d138671a1742178fc7 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 1 Feb 2024 14:51:47 -0500 Subject: [PATCH 28/31] MAINT: updated RTD python version Updated the RTD python version. --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index e1667025..b198cf86 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.10" + python: "3.11" # Build documentation in the docs/ directory with Sphinx sphinx: From 213ed1156b9d3b8f98b429a3585ed6c11b373a5c Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Wed, 7 Feb 2024 14:13:40 -0500 Subject: [PATCH 29/31] DOC: Update ACKNOWLEDGEMENTS.md Expanded wording on disclaimer. Co-authored-by: Russell Stoneback --- ACKNOWLEDGEMENTS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md index 1aa5a0d3..16086257 100644 --- a/ACKNOWLEDGEMENTS.md +++ b/ACKNOWLEDGEMENTS.md @@ -20,6 +20,6 @@ Programs Disclaimers =========== -Any opinions, findings, and conclusions or recommendations expressed in this +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. From 7ca8576cbdb28daa2315023c6880a4e4be6d9a77 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Thu, 15 Feb 2024 18:01:05 -0500 Subject: [PATCH 30/31] REL: updated release date Updated the release date for tomorrow. --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fdc66eaf..e14b8991 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.0] - 2023-XX-XX +[0.1.0] - 2024-02-16 -------------------- * Enhancements * Changed downloads to write files across multiple Instruments when the From acef67c63b43bb3c954077d8adf9d7ca1e66a7a3 Mon Sep 17 00:00:00 2001 From: Angeline Burrell Date: Fri, 16 Feb 2024 16:29:33 -0500 Subject: [PATCH 31/31] BUG: updated test dates Updated test dates for 45 day file, which may not be updated frequently. --- pysatSpaceWeather/instruments/sw_ap.py | 2 +- pysatSpaceWeather/instruments/sw_f107.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pysatSpaceWeather/instruments/sw_ap.py b/pysatSpaceWeather/instruments/sw_ap.py index 147ca5fa..cc20853e 100644 --- a/pysatSpaceWeather/instruments/sw_ap.py +++ b/pysatSpaceWeather/instruments/sw_ap.py @@ -102,7 +102,7 @@ 'forecast': tomorrow, 'prediction': tomorrow, 'recent': today, - '45day': tomorrow}} + '45day': today}} # ---------------------------------------------------------------------------- # Instrument methods diff --git a/pysatSpaceWeather/instruments/sw_f107.py b/pysatSpaceWeather/instruments/sw_f107.py index 53854ebb..d3ca6b54 100644 --- a/pysatSpaceWeather/instruments/sw_f107.py +++ b/pysatSpaceWeather/instruments/sw_f107.py @@ -109,7 +109,7 @@ 'prelim': dt.datetime(2009, 1, 1), 'daily': today, 'forecast': tomorrow, - '45day': tomorrow}, + '45day': today}, 'obs': {'now': dt.datetime(2009, 1, 1)}, 'adj': {'now': dt.datetime(2009, 1, 1)}}