Merge pull request #113 from pysat/rc_0_3_4

Release Candidate 0.3.4
pysat · Jun 22, 2023 · 2a4a154 · 2a4a154
2 parents 12801e4 + ffaf150
commit 2a4a154
Show file tree

Hide file tree

Showing 33 changed files with 816 additions and 211 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,29 +1,29 @@
 ---
 name: Bug report
 about: Create a report to help us improve
+labels: bug
+title: "BUG: "
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+# Description
+A clear and concise description of what the bug is, including a description
+of what you expected the outcome to be.
 
-**To Reproduce**
+# To Reproduce this bug:
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+Consider including images or test files to help others reproduce the bug and
+solve the problem.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Version [e.g. 22]
+## Test configuration
+ - OS: [e.g. Hal]
+ - Version: [e.g. Python 3.47]
  - Other details about your setup that could be relevant
 
-**Additional context**
-Add any other context about the problem here.
+# Additional context
+Add any other context about the problem here, including expected behaviour.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,17 +1,27 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
+title: "ENH: "
+labels: enhancement
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+# Description
+A clear and concise description of the new feature or behaviour you would like.
 
-**Describe the solution you'd like**
+## Potential impact
+
+- Is the feature related to an existing problem?
+- How critical is this feature to your workflow?
+- How wide of an impact to you anticipate this enhancement having?
+- Would this break any existing functionality?
+
+## Potential solution(s)
 A clear and concise description of what you want to happen.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+# Alternatives
+A clear description of any alternative solutions or features you've considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+# Additional context
+Add any other context or screenshots about the feature request here, potentially
+including your operational configuration.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,19 @@
+---
+name: Question
+about: A question about this project
+title: "QUEST: "
+labels: question
+
+---
+
+# Description
+A clear and concise summary of your query
+
+## Example code (optional)
+If relevant, include sample code, images, or files so that others can understand
+the full context of your question.
+
+## Configuration
+ - OS: [e.g. Hal]
+ - Version: [e.g. Python 3.47]
+ - Other details about your setup that could be relevant
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -25,9 +25,9 @@ your test configuration
 - Test A
 - Test B
 
-**Test Configuration**:
-* Operating system
-* Version number
+## Test Configuration
+* Operating system: Hal
+* Version number: Python 3.X
 * Any details about your local setup that are relevant
 
 # Checklist:
@@ -42,3 +42,8 @@ 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
+- [ ] Update zenodo.json file for new code contributors
+
+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/docs.yml b/.github/workflows/docs.yml
@@ -8,25 +8,22 @@ on: [push, pull_request]
 jobs:
   build:
 
-    runs-on: ubuntu-latest
+    runs-on: ["ubuntu-latest"]
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.9]
+        python-version: ["3.11"]
 
     name: Documentation tests
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -r test_requirements.txt
+    - name: Install with dependencies
+      run: pip install .[doc]
 
     - name: Check documentation build
       run: sphinx-build -E -b html docs dist/docs

diff --git a/.github/workflows/external_rc.yml b/.github/workflows/external_rc.yml
@@ -0,0 +1,45 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test with latest optional package RC
+
+on: [workflow_dispatch]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.10"]
+        rc-package: ["aacgmv2", "apexpy", "OMMBV"]
+
+    name: ${{ matrix.rc-package }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install standard dependencies
+      run: |
+        pip install -r requirements.txt
+        pip install -r test_requirements.txt
+
+    - name: Install RC dependency
+      run: pip install -i https://test.pypi.org/simple/  --extra-index-url https://pypi.org/simple/ ${{ matrix.rc-package }}
+
+    - name: Set up pysat
+      run: |
+        mkdir pysatData
+        python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"
+
+    - name: Test with pytest
+      run: pytest -vs --cov=pysatMissions/
+
+    - name: Publish results to coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: coveralls --rcfile=setup.cfg --service=github
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -11,30 +11,53 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
-        os: ["ubuntu-latest", "windows-latest"]
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ["3.10", "3.11"]
         numpy_ver: ["latest"]
+        include:
+          - python-version: "3.9"
+            numpy_ver: "1.21"
+            os: "ubuntu-latest"
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.os }} with numpy ${{ matrix.numpy_ver }}
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Install requirements for testing setup
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r test_requirements.txt
+    - name: Reinstall fortran on MacOS
+      if: ${{ matrix.os == 'macos-latest' }}
+      run: brew reinstall gcc
 
-    - name: Install dependencies
+    - name: Install NEP29 dependencies
+      if: ${{ matrix.numpy_ver != 'latest'}}
       run: |
-        pip install -r requirements.txt
-        pip install aacgmv2 --no-binary==aacgmv2
-        pip install apexpy --no-binary==apexpy
-        pip install OMMBV --no-binary==OMMBV
+        pip install numpy==${{ matrix.numpy_ver }}
+        pip install --upgrade-strategy only-if-needed .[test]
+
+    - name: Install standard dependencies
+      if: ${{ matrix.numpy_ver == 'latest'}}
+      run: pip install .[test]
+
+    - name: Install aacgmv2
+      # Optional package, continue with tests if install fails
+      continue-on-error: true
+      run: pip install aacgmv2 --no-binary==aacgmv2
+
+    - name: Install apexpy
+      # Skip apexpy for nep29 tests
+      if: ${{ matrix.numpy_ver == 'latest'}}
+      # Optional package, continue with tests if install fails
+      continue-on-error: true
+      run: pip install apexpy --no-binary==apexpy
+
+    - name: Install OMMBV
+      # Optional package, continue with tests if install fails
+      continue-on-error: true
+      run: pip install OMMBV --no-binary==OMMBV
 
     - name: Set up pysat
       run: |
@@ -48,10 +71,9 @@ jobs:
       run: flake8 . --count --exit-zero --max-complexity=10 --statistics
 
     - name: Test with pytest
-      run: |
-        pytest --cov=pysatMissions/
+      run: pytest
 
     - name: Publish results to coveralls
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: coveralls --rcfile=setup.cfg --service=github
+      run: coveralls --rcfile=pyproject.toml --service=github
diff --git a/.github/workflows/pip_rc_install.yml b/.github/workflows/pip_rc_install.yml
@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies and the latest RC of pysatNASA from test pypi.
+# This test should be manually run before a pysatNASA RC is officially approved and versioned.
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test install of latest RC from pip
+
+on: [workflow_dispatch]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ["3.11"]  # 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
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install standard dependencies
+      run: pip install -r requirements.txt
+
+    - name: Install pysatMissions RC
+      run: pip install --no-deps --pre -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pysatMissions
+
+    - name: Set up pysat
+      run: |
+        mkdir pysatData
+        python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"
+    - name: Check that install imports correctly
+      run: |
+        cd ..
+        python -c "import pysatMissions; print(pysatMissions.__version__)"
diff --git a/.github/workflows/pysat_rc.yml b/.github/workflows/pysat_rc.yml
@@ -0,0 +1,44 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Test with latest pysat RC
+
+on: [workflow_dispatch]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["macos-latest", "ubuntu-latest", "windows-latest"]
+        python-version: ["3.10"]
+
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      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: Set up pysat
+      run: |
+        mkdir pysatData
+        python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"
+
+    - name: Test with pytest
+      run: pytest -vs --cov=pysatMissions/
+
+    - name: Publish results to coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: coveralls --rcfile=setup.cfg --service=github
diff --git a/.zenodo.json b/.zenodo.json
@@ -2,7 +2,7 @@
     "creators": [
       {
         "affiliation": "Goddard Space Flight Center",
-        "name": "Klenzing, Jeffrey",
+        "name": "Klenzing, Jeff",
         "orcid": "0000-0001-8321-6074"
       },
       {
@@ -30,6 +30,7 @@
         "orcid": "0000-0002-8191-4765"
       },
       {
+        "affiliation": "Universities Space Research Association, Goddard Space Flight Center",
         "name": "Bhaneja, Preeti",
         "orcid": "0000-0003-4900-2747"
       }