Merge 73a49ed into bbb8271

pysat · Sep 1, 2022 · d72135f · d72135f
2 parents bbb8271 + 73a49ed
commit d72135f
Show file tree

Hide file tree

Showing 39 changed files with 2,980 additions and 1,166 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -26,9 +26,9 @@ your test configuration
 - Test B
 
 **Test Configuration**:
-* Operating system
-* Version number
-* Any details about your local setup that are relevant
+* Operating system: Hal
+* Version number: Python 3.X
+* Any details about your local setup that are relevant: pysat version X
 
 # Checklist:
 
@@ -42,3 +42,7 @@ your test configuration
 - [ ] New and existing unit tests pass locally with my changes
 - [ ] Any dependent changes have been merged and published in downstream modules
 - [ ] Add a note to ``CHANGELOG.md``, summarizing the changes
+
+ If this is a release PR, replace the first item of the above checklist with the
+ release checklist on the pysat wiki:
+ https://github.com/pysat/pysat/wiki/Checklist-for-Release
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -10,8 +10,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7]
-        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.9", "3.10"]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        numpy_ver: [latest]
+        include:
+           - python-version: "3.8"
+             numpy_ver: "1.21"
+             os: "ubuntu-latest"
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
@@ -22,19 +27,26 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install dependencies
+    - name: Install requirements for testing setup
       run: |
-        python -m pip install --upgrade pip
         pip install -r test_requirements.txt
+
+    - name: Install dependencies
+      run: |
         pip install -r requirements.txt
 
+    - name: Install NEP29 dependencies
+      if: ${{ matrix.numpy_ver != 'latest'}}
+      run: |
+        pip install --no-binary :numpy: numpy==${{ matrix.numpy_ver }}
+
     - name: Set up pysat
       run: |
         mkdir pysatData
         python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"
 
     - name: Test PEP8 compliance
-      run: flake8 . --count --select=E,F,W --show-source --statistics
+      run: flake8 . --count --select=D,E,F,H,W --show-source --statistics
 
     - name: Evaluate complexity
       run: flake8 . --count --exit-zero --max-complexity=10 --statistics

diff --git a/.zenodo.json b/.zenodo.json
@@ -6,7 +6,7 @@
         "orcid": "0000-0001-8321-6074"
       },
       {
-        "affiliation": "The University of Texas at Dallas",
+        "affiliation": "Stoneris",
         "name": "Stoneback, Russell",
         "orcid": "0000-0001-7216-4336"
       },

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,10 +2,30 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.2.0] - 2022-XX-XX
-- Removed deprecated `pandas.Panel` from functions.
-- Renamed `computational_form` to `to_xarray_dataset` and refocused.
-- Removed old __future__ imports.
+## [0.2.0] - 2022-08-12
+- New Features
+  - Added support for xarray data in the seasonal averaging functions in `pysatSeasons.avg`
+  - Added support for xarray data in the occurrence probability functions in `pysatSeasons.occur_prob`
+  - Added support for Constellations in `pysatSeasons.occur_prob`
+  - Added support for Constellations in `pysatSeasons.plot`
+  - Renamed `computational_form` to `to_xarray_dataset` and refocused.
+- Deprecations
+  - Deprecated `returnBins` keyword in favor of `return_bins` in `pysatSeasons.occur_prob`.
+  - Deprecated `returnData` keyword in favor of `return_data` in `pysatSeasons.avg`.
+- Documentation
+  - Improved docstrings throughout.
+  - Updated documentation examples.
+  - Documentation now available on readthedocs.org.
+- Bug Fix
+- Maintenance
+  - Removed deprecated `pandas.Panel` from functions.
+  - Removed old `__future__` imports.
+  - Removed use of `collections.deque` in `pysatSeasons.avg`.
+  - Migrated to GitHub Workflows for CI testing.
+  - Migrated from nose to pytest.
+  - Adopted setup.cfg
+  - Updated style standards
+  - Added automated style and docstring testing
 
 ## [0.1.3] - 2021-06-18
 - Updates style to match pysat 3.0.0 release candidate

diff --git a/README.md b/README.md
@@ -1,46 +1,40 @@
 <div align="left">
         <img height="0" width="0px">
-        <img width="20%" src="https://raw.githubusercontent.com/pysat/pysatSeasons/main/poweredbypysat.png" alt="pysat" title="pysat"</img>
+        <img width="20%" src="https://raw.githubusercontent.com/pysat/pysatSeasons/main/docs/images/logo.png" alt="The pysatSeasons logo: A calendar page featuring a snake orbiting a blue planet" title="pysatSeasons"</img>
 </div>
 
 # pysatSeasons
+[![Documentation Status](https://readthedocs.org/projects/pysatseasons/badge/?version=latest)](https://pysatseasons.readthedocs.io/en/latest/?badge=latest)
 [![PyPI Package latest release](https://img.shields.io/pypi/v/pysatSeasons.svg)](https://pypi.python.org/pypi/pysatSeasons)
-[![Build Status](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)
+[![Build Status](https://github.com/pysat/pysatSeasons/actions/workflows/main.yml/badge.svg)](https://github.com/pysat/pysatSeasons/actions/workflows/main.yml/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/pysat/pysatSeasons/badge.svg?branch=main)](https://coveralls.io/github/pysat/pysatSeasons?branch=main)
 [![DOI](https://zenodo.org/badge/209365329.svg)](https://zenodo.org/badge/latestdoi/209365329)
 
 
 
-This code will handle the seasonal analysis routines for pysat.  It is currently a work in progress, and will eventually replace the pysat.ssnl module in pysat.
-
-pysatSeasons allows users to run basic seasonal analysis over N-dimensional datasets managed through the pysat code.
+pysatSeasons allows users to run seasonal data analyses over N-dimensional 
+data sets managed through the pysat module.
 
 Main Features
 -------------
-- Seasonal averaging routine for 1D and 2D data.
+- Seasonal binning and averaging routines for 1D and 2D distributions of nD data.
 - Occurrence probability routines, daily or by orbit.
-- Scatterplot of data_label(s) as functions of labelx,y
-    over a season.
+- Scatterplot of data_label(s) over two dimensions over a season.
 
 
 # Installation
 
 ### Prerequisites
 
 pysatSeasons uses common Python modules, as well as modules developed by
-and for the Space Physics community.  This module officially supports
-Python 3.7.  Note that the current release is based on archived routines from
-pysat 2.0.  This currently requires the deprecated `Panel` from pandas.
-The caps on numpy and python stem from compatibility with the maximum
-supported pandas version.  Version 0.2.0 will rewrite the routines to remove
-`Panel`.
-
-| Common modules | Community modules |
-| -------------- | ----------------- |
-| matplotlib     | pysat             |
-| numpy<1.20     |                   |
-| pandas<0.24    |                   |
-
+and for the Space Physics community.  
+
+| Common modules   | Community modules |
+| --------------   | ----------------- |
+| matplotlib       | pysat >= 3.0.4    |
+| numpy            |                   |
+| pandas           |                   |
+| xarray           |                   |
 
 ## GitHub Installation