Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release Candidate 0.0.5 #61

Open
wants to merge 66 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 53 commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
b753d06
Merge pull request #50 from pysat/main
jklenzing Aug 15, 2023
9d3413c
MAINT: update workflows
jklenzing Dec 1, 2023
2e3965d
DOC: update changelog
jklenzing Dec 1, 2023
62087c8
MAINT: version cap for sphinx rtd theme
jklenzing Dec 1, 2023
af8d257
MAINT: pysat 3.2.0 compat
jklenzing Dec 1, 2023
1c682e7
MAINT: turn off new tests for gps
jklenzing Feb 20, 2024
7ffde7c
MAINT: set version limit for pysat
jklenzing Feb 20, 2024
d1bafd1
DOC: add issue to TBD
jklenzing Feb 20, 2024
37a3b89
TST: verbose tests
jklenzing Feb 20, 2024
11e3bf6
MAINT: update GA versions
jklenzing Feb 20, 2024
7aaf5eb
Apply suggestions from code review
jklenzing Feb 20, 2024
b3c12e3
Update NEP29 tests
jklenzing Mar 28, 2024
bdd2ee6
Merge pull request #52 from pysat/maint/rc
jklenzing Mar 28, 2024
706849e
Update requirements.txt
jklenzing Mar 28, 2024
d6442eb
Merge pull request #55 from pysat/jklenzing-patch-1
jklenzing Apr 10, 2024
fe30451
Create patch.yml
Aadarsh-Govada Jul 16, 2024
68e0e9a
Add source installation of pysat patch-develop branch
Aadarsh-Govada Jul 16, 2024
7a7b7fc
Add -y to pip uninstall
Aadarsh-Govada Jul 16, 2024
7ff9aaf
STY: Update python versions in main workflow
Aadarsh-Govada Jul 30, 2024
886bafe
TST: Use patched pysat rc for patch workflow
Aadarsh-Govada Jul 30, 2024
8721178
Update patch.yml
Aadarsh-Govada Jul 30, 2024
c102a8a
Cap numpy at 3.2.0
Aadarsh-Govada Jul 30, 2024
282de5d
BUG: Remove numpy 3.2.0 cap and update to 'np.prod()'
Aadarsh-Govada Jul 30, 2024
f26c5ce
Delete .github/workflows/patch.yml
Aadarsh-Govada Jul 30, 2024
a971074
DOC: Update .zenodo.json
Aadarsh-Govada Jul 30, 2024
9fd6dd3
Update CHANGELOG.md
jklenzing Jul 30, 2024
3fe6c3a
Merge pull request #56 from pysat/patch-develop
jklenzing Jul 30, 2024
567ad37
MAINT: Update deprecated 'Dataset.dims' usage to 'Dataset.sizes'
Aadarsh-Govada Jul 30, 2024
254f00f
Undo previous commit
Aadarsh-Govada Jul 30, 2024
4ef4a4b
Update deprecated 'Dataset.dims' usage to 'Dataset.sizes'
Aadarsh-Govada Jul 30, 2024
efac813
DOC: Update CHANGELOG.md
Aadarsh-Govada Jul 30, 2024
1831cc2
Merge pull request #57 from pysat/future-warn
jklenzing Aug 1, 2024
43fcb1a
DOC: added acknowledgements
aburrell Sep 6, 2024
ae7359b
DOC: updated doc index
aburrell Sep 6, 2024
cea00f9
DOC: updated header
aburrell Sep 6, 2024
0968adc
DOC: fixed package name
aburrell Sep 6, 2024
cdd7553
Merge pull request #58 from pysat/nrl_pub_release
aburrell Sep 23, 2024
6101ee1
DOC: update changelog
jklenzing Oct 4, 2024
91f1bed
MAINT: update metadata
jklenzing Oct 4, 2024
e79ca37
MAINT: update GitHub Actions
jklenzing Oct 4, 2024
6895781
TST: test against minimum supported pysat
jklenzing Oct 4, 2024
9e56005
Update main.yml
jklenzing Oct 7, 2024
5e742e7
MAINT: update minimum pysat
jklenzing Oct 7, 2024
8dc360d
DOC: update changleog
jklenzing Oct 7, 2024
3ba74cc
MAINT: set minimum python version to 3.9
jklenzing Oct 7, 2024
b326bcd
DOC: update docs
jklenzing Oct 7, 2024
15074e4
MAINT: remove unused code for python 3.6
jklenzing Oct 7, 2024
563188b
MAINT: set minimum pysat version
jklenzing Nov 7, 2024
dc0aec6
Merge pull request #59 from pysat/maint/pysat
jklenzing Nov 13, 2024
ca92d49
MAINT: update for RC
jklenzing Nov 13, 2024
5e1b68b
MAINT: use coveralls app
jklenzing Nov 15, 2024
1603185
BUG: pyproject options
jklenzing Nov 15, 2024
8a8b846
BUG: revert to old coveralls
jklenzing Nov 18, 2024
a0edf84
MAINT: update author info / order
jklenzing Nov 20, 2024
dc54b64
LGL: Update controlled information statement for clarity and accuracy
rstoneback Dec 18, 2024
a4984fd
STY: Update admonition line that unit test don't appreciate
rstoneback Dec 19, 2024
f7ca320
STY: Update admonition line that unit test don't appreciate
rstoneback Dec 19, 2024
df35e71
STY: Tweak table and correct listed requirements
rstoneback Dec 20, 2024
5071297
BUG: Trying to sort out table error in pre-existing documentation
rstoneback Dec 20, 2024
50c831a
TST: Remove table in doc
rstoneback Dec 20, 2024
e3bbc74
TST: Re-add table
rstoneback Dec 20, 2024
98b6bca
Merge branch 'rc0_0_5' into controlled_information
rstoneback Dec 20, 2024
3901a94
TST: Remove extras require
rstoneback Dec 20, 2024
c935c51
STY: Correct Zenodo author info
rstoneback Dec 20, 2024
7ee063b
TST: Comment out extras require until RTD is sorted out
rstoneback Dec 20, 2024
31285b5
Merge pull request #63 from pysat/controlled_information
rstoneback Jan 13, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ jobs:

name:
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 }}

Expand Down
50 changes: 36 additions & 14 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,48 @@ jobs:
fail-fast: false
matrix:
os: ["ubuntu-latest", "macos-latest", "windows-latest"]
python-version: ["3.10", "3.11"]
python-version: ["3.11", "3.12"]
numpy_ver: ["latest"]
test_config: ["latest"]
include:
- python-version: "3.9"
numpy_ver: "1.21"
# SPEC-0 compliance settings w/ minimum supported pysat
- python-version: "3.10"
numpy_ver: "1.24"
pandas_ver: "1.5.0"
scipy_ver: "1.10.0"
xarray_ver: "2022.9.0"
pysat_ver: "3.2.1"
os: ubuntu-latest
test_config: "NEP29"
- python-version: "3.6.8"
numpy_ver: "1.19.5"
test_config: "SPEC0"
# Operational compliance settings
- python-version: "3.9"
numpy_ver: "1.23.5"
os: "ubuntu-20.04"
test_config: "Ops"

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

- name: Install Operational dependencies
if: ${{ matrix.test_config == 'Ops'}}
run: |
pip install --no-cache-dir numpy==${{ matrix.numpy_ver }}
pip install -r requirements.txt
pip install -r test_requirements.txt
pip install .
pip install numpy==${{ matrix.numpy_ver }}
pip install --upgrade-strategy only-if-needed .[test]

- name: Install NEP29 dependencies
if: ${{ matrix.test_config == 'NEP29'}}
- name: Install SPEC-0 dependencies
if: ${{ matrix.test_config == 'SPEC0'}}
run: |
pip install numpy==${{ matrix.numpy_ver }}
pip install pandas==${{ matrix.pandas_ver }}
pip install scipy==${{ matrix.scipy_ver }}
pip install xarray==${{ matrix.xarray_ver }}
pip install pysat==${{ matrix.pysat_ver }}
pip install --upgrade-strategy only-if-needed .[test]

- name: Install standard dependencies
Expand All @@ -69,4 +77,18 @@ jobs:
- name: Publish results to coveralls
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COVERALLS_PARALLEL: true
run: coveralls --rcfile=pyproject.toml --service=github
aburrell marked this conversation as resolved.
Show resolved Hide resolved

finish:
name: Finish Coverage Analysis
needs: build
runs-on: ubuntu-latest
steps:
- name: Coveralls Finished
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
pip install --upgrade coveralls
coveralls --service=github --finish

4 changes: 2 additions & 2 deletions .github/workflows/pip_rc_install.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ jobs:
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 }}

Expand Down
29 changes: 20 additions & 9 deletions .github/workflows/pysat_rc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,46 @@ jobs:
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: ["3.10"]
os: ["ubuntu-latest", "macos-latest", "windows-latest"]
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 }}

- name: Install pysat RC
run: pip install --no-deps --pre -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pysat

- name: Install standard dependencies
run: |
pip install -r requirements.txt
pip install -r test_requirements.txt
- name: Install standard dependencies and package
run: pip install .[test]

- name: Set up pysat
run: |
mkdir pysatData
python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"

- name: Test with pytest
run: pytest
run: pytest -v

- name: Publish results to coveralls
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
COVERALLS_PARALLEL: true
run: coveralls --rcfile=pyproject.toml --service=github

finish:
name: Finish Coverage Analysis
needs: build
runs-on: ubuntu-latest
steps:
- name: Coveralls Finished
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
pip install --upgrade coveralls
coveralls --service=github --finish
aburrell marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 5 additions & 0 deletions .zenodo.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@
{
"name": "Spence, Carey",
"orcid": "0000-0001-8340-5625"
},
{
"affiliation": "Universities Space Research Association, Goddard Space Flight Center",
"name": "Govada, Aadarsh",
"orcid": "0009-0004-7873-5899"
}
]
}
34 changes: 34 additions & 0 deletions ACKNOWLEDGEMENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Funding
=======
The following institutions, missions, and programs have provided funding
for pysatCDAAC development.

Institutions
------------
- The Catholic University of America (CUA)
- Cosmic Studio
- Defense Advanced Research Projects Agency (DARPA) Defense Sciences Office
- National Aeronautics and Space Administration (NASA)
- National Oceanic and Atmospheric Administration (NOAA)
- National Science Foundation (NSF)
- Office of Naval Research (ONR)

Missions
--------
- NOAA Constellation Observing System for Meteorology Ionosphere and Climate
(COSMIC-2)

Programs
--------
- NSF 125908, AGS-1651393
- NASA Space Precipitation Impacts (SPI) project at Goddard Space Flight Center
through the Heliophysics Internal Science Funding Model.
- Naval Research Laboratory N00173191G016 and N0017322P0744

Disclaimers
===========
Any opinions or actions taken by the listed funding institutions are those of
the institutions and do not necessarily reflect the views of the pysatCDAAC
development team or individual authors. Any opinions, findings, and conclusions
or recommendations expressed in this material are those of the author(s) and do
not necessarily reflect the views of the funding agencies.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,16 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.0.5] - 2024-11-20
* Maintenance
* Update GitHub Actions standards, including SPEC-0 tests
* Add compatibility for numpy version>=3.2.0
* Update usage of 'Dataset.dims' to 'Dataset.sizes'
* Update compatibility with pysat 3.2.1
* Set minimum pysat version to 3.2.1
* Set minimum python version to 3.9
* Update operational environment

## [0.0.4] - 2023-08-11
* Bug fixes
* Update metadata transfer for COSMIC GPS
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ pysatCDAAC uses common Python modules, as well as modules developed by
and for the Space Physics community. This module officially supports
Python 3.7+.

| Common modules | Community modules |
| -------------- | ----------------- |
| netCDF4 | pysat>=3.0.4 |
| numpy | |
| pandas | |
| requests | |
| xarray | |
| Common modules | Community modules |
| -------------- | ------------------- |
| netCDF4 | pysat>=3.2.1 |
| numpy | |
| pandas | |
| requests | |
| xarray | |

# Installation

Expand Down
1 change: 1 addition & 0 deletions docs/acknowledgements.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. mdinclude:: ../ACKNOWLEDGEMENTS.md
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# -*- coding: utf-8 -*-
# Full author list can be found in .zenodo.json file
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Configuration file for the Sphinx documentation builder.

Note
Expand Down
5 changes: 5 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ Center (CDAAC) as pysat.Instrument objects.
examples.rst
develop_guide.rst
history.rst
acknowledgements.rst


.. admonition:: DISTRIBUTION STATEMENT A: Approved for public release.
Distribution is unlimited.


Indices and tables
Expand Down
10 changes: 5 additions & 5 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ Prerequisites

pysatCDAAC uses common Python modules, as well as modules developed by
and for the Space Physics community. This module officially supports
Python 3.6+ and pysat 3.0.4+.
Python 3.9+ and pysat 3.2.1+.

================== =================
================== ====================
Common modules Community modules
================== =================
netCDF4 pysat>=3.0.4
================== ====================
netCDF4 pysat>=3.2.1
numpy
pandas
requests
xarray
================== =================
================== ====================


Installation Options
Expand Down
12 changes: 6 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta"

[project]
name = "pysatCDAAC"
version = "0.0.4"
version = "0.0.5"
description = "pysat support for CDAAC Instruments"
readme = "README.md"
requires-python = ">=3.6"
requires-python = ">=3.9"
license = {file = "LICENSE"}
authors = [
{name = "Jeff Klenzing, et al.", email = "[email protected]"},
Expand All @@ -21,10 +21,10 @@ classifiers = [
"License :: OSI Approved :: BSD License",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"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"
Expand All @@ -39,7 +39,7 @@ dependencies = [
"netCDF4",
"numpy",
"pandas",
"pysat >= 3.0.4",
"pysat >= 3.2.1",
"requests",
"xarray"
]
Expand All @@ -61,7 +61,7 @@ doc = [
"numpydoc",
"sphinx < 7.0",
"sphinx-autoapi",
"sphinx_rtd_theme >= 1.2.2"
"sphinx_rtd_theme >= 1.2.2, <2.0.0"
]

[project.urls]
Expand All @@ -71,7 +71,7 @@ Source = "https://github.com/pysat/pysatCDAAC"
[tool.coverage.report]

[tool.pytest.ini_options]
addopts = "--cov=pysatCDAAC"
addopts = "--cov=pysatCDAAC --cov-report xml"
markers = [
"all_inst",
"download",
Expand Down
14 changes: 8 additions & 6 deletions pysatCDAAC/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# -*- coding: utf-8 -*-
# Full author list can be found in .zenodo.json file
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Core library for pysatCDAAC.

This is a library of `pysat` instrument modules and methods designed to support
Expand All @@ -9,9 +16,4 @@
from pysatCDAAC import instruments # noqa F401

# Set version
try:
__version__ = importlib.metadata.version('pysatCDAAC')
except AttributeError:
# Python 3.6 requires a different version
import importlib_metadata
__version__ = importlib_metadata.version('pysatCDAAC')
__version__ = importlib.metadata.version('pysatCDAAC')
6 changes: 6 additions & 0 deletions pysatCDAAC/instruments/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# -*- coding: utf-8 -*-
# Full author list can be found in .zenodo.json file
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Collection of instruments for the pysatCDAAC library.

Each instrument is contained within a subpackage of this set.
Expand Down
6 changes: 6 additions & 0 deletions pysatCDAAC/instruments/cosmic2_ivm.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# -*- coding: utf-8 -*-
# Full author list can be found in .zenodo.json file
# DOI:10.5281/zenodo.3475493
#
# DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
# unlimited.
# ----------------------------------------------------------------------------
"""Supports IVM data from the COSMIC2 satellite.

The Constellation Observing System for Meteorology, Ionosphere, and Climate
Expand Down
Loading