Merge pull request #141 from pysat/nrl_pub_release

RC v01.0 update

.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 }}
 

.github/workflows/main.yml

@@ -16,13 +16,13 @@ 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:
           # NEP29 compliance settings
           - python-version: "3.9"
-            numpy_ver: "1.21"
+            numpy_ver: "1.23"
             os: ubuntu-latest
             test_config: "NEP29"
           # Operational compliance settings
@@ -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 }}
 

.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 }}
 

.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 }}
 

.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:

ACKNOWLEDGEMENTS.md

@@ -0,0 +1,25 @@
+Funding
+=======
+The following institutions, missions, and programs have provided funding
+for pysatSpaceWeather development.
+
+Institutions
+------------
+ - The Catholic University of America (CUA)
+ - Cosmic Studio
+ - Defense Advanced Research Projects Agency (DARPA) Defense Sciences Office
+ - National Aeronautics and Space Administration (NASA)
+ - National Science Foundation (NSF)
+ - Office of Naval Research (ONR)
+
+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
+===========
+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.

CHANGELOG.md

@@ -3,10 +3,15 @@ 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.X] - 2024-XX-XX
+--------------------
+* Maintenance
+  * Removed unneeded keyword arguments from Kp method functions
+
+[0.1.0] - 2024-02-16
 --------------------
 * 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
@@ -15,13 +20,15 @@ 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
   * 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
-  * Removed unneeded keyword arguments from Kp method functions
+  * Updated code headers to include license, reference, and pub release info
+  * Updated the supported python versions
 
 [0.0.10] - 2023-06-01
 ---------------------

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

docs/acknowledgements.rst

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

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.

docs/index.rst

@@ -19,6 +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.
+
 
 
 Indices and tables

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

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 <https://lasp.colorado.edu/space_weather/dsttemerin/dsttemerin.html>`_.
@@ -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 <https://www.gfz-potsdam.de/en/kp-index/>`_ and the
 `SWPC Forecasts page <https://www.swpc.noaa.gov/forecasts>`_.
@@ -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 <https://kp.gfz-potsdam.de/en/hp30-hp60>`_.
 
@@ -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 <https://www.swpc.noaa.gov/phenomena>`_.
@@ -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 <https://kp.gfz-potsdam.de/en/hp30-hp60>`_.
 
@@ -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:

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 = "[email protected]"}
 ]
 classifiers = [
-  "Development Status :: 3 - Alpha",
+  "Development Status :: 4 - Beta",
   "Topic :: Scientific/Engineering :: Astronomy",
   "Topic :: Scientific/Engineering :: Physics",
   "Topic :: Scientific/Engineering :: Atmospheric Science",
@@ -22,10 +22,10 @@ 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",
+  "Programming Language :: Python :: 3.12",
   "Operating System :: POSIX :: Linux",
   "Operating System :: MacOS :: MacOS X",
   "Operating System :: Microsoft :: Windows"
@@ -81,6 +81,7 @@ markers = [
   "download",
   "no_download",
   "load_options",
+  "new_tests",
   "first",
   "second"
 ]

pysatSpaceWeather/instruments/ace_epam.py

@@ -1,4 +1,12 @@
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-.
+# Full license can be found in License.md
+# Full author list can be found in .zenodo.json file
+# DOI:10.5281/zenodo.3986138
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Supports ACE Electron, Proton, and Alpha Monitor data.
 
 Properties

pysatSpaceWeather/instruments/ace_mag.py

@@ -1,4 +1,12 @@
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-.
+# Full license can be found in License.md
+# Full author list can be found in .zenodo.json file
+# DOI:10.5281/zenodo.3986138
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Supports ACE Magnetometer data.
 
 Properties

pysatSpaceWeather/instruments/ace_sis.py

@@ -1,4 +1,12 @@
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-.
+# Full license can be found in License.md
+# Full author list can be found in .zenodo.json file
+# DOI:10.5281/zenodo.3986138
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Supports ACE Solar Isotope Spectrometer data.
 
 Properties

pysatSpaceWeather/instruments/ace_swepam.py

@@ -1,4 +1,12 @@
-# -*- coding: utf-8 -*-
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-.
+# Full license can be found in License.md
+# Full author list can be found in .zenodo.json file
+# DOI:10.5281/zenodo.3986138
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Supports ACE Solar Wind Electron Proton Alpha Monitor data.
 
 Properties

pysatSpaceWeather/instruments/methods/ace.py

@@ -3,6 +3,9 @@
 # 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.
 # ----------------------------------------------------------------------------
 """Provides general routines for the ACE space weather instruments."""
 
@@ -212,7 +215,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,

pysatSpaceWeather/instruments/methods/auroral_electrojet.py

@@ -1,4 +1,12 @@
+#!/usr/bin/env python
 # -*- coding: utf-8 -*-.
+# Full license can be found in License.md
+# Full author list can be found in .zenodo.json file
+# DOI:10.5281/zenodo.3986138
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Provides support routines for auroral electrojet indices."""
 
 

pysatSpaceWeather/instruments/methods/dst.py

@@ -1,4 +1,12 @@
+#!/usr/bin/env python
 # -*- coding: utf-8 -*-.
+# Full license can be found in License.md
+# Full author list can be found in .zenodo.json file
+# DOI:10.5281/zenodo.3986138
+#
+# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
+# unlimited.
+# ----------------------------------------------------------------------------
 """Provides default routines for Dst."""
 
 

pysatSpaceWeather/instruments/methods/f107.py

@@ -3,6 +3,9 @@
 # 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.
 # ----------------------------------------------------------------------------
 
 """Routines for the F10.7 solar index."""