Merge pull request #139 from aburrell/ssj_dep

DEP: removed support for `dmsp_ssj_boundaries`

.github/workflows/docs.yml

@@ -25,13 +25,11 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Set CDF Lib environment variable
-      run: echo "CDF_LIB=$HOME/lib" >> $GITHUB_ENV
-
-    - name: Install dependencies
+    - name: Install doc and optional dependencies
       run: |
         pip install .[doc]
-        bash requirements.extra 2
+        pip install .[dmsp_ssj]
+        pip install .[pysat_instruments]
 
     - name: Check documentation build
       run: sphinx-build -E -b html docs dist/docs

.github/workflows/main.yml

@@ -14,9 +14,9 @@ jobs:
       matrix:
         os: ["ubuntu-latest", "macos-latest", "windows-latest"]
         python-version: ["3.9", "3.10", "3.11", "3.12"]
-        install-extras: [0, 1]  # TODO(#129): update to replace extra flag
+        install-extras: ["base", "pysat_instruments", "dmsp_ssj"]
 
-    name: Python ${{ matrix.python-version }} on ${{ matrix.os }} with extras ${{ matrix.install-extras }}
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }} with ${{ matrix.install-extras }}
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
@@ -25,23 +25,18 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
 
-    - name: Set CDF Lib environment variable
-      if: ${{ matrix.install-extras == 2 }}
-      run: echo "CDF_LIB=$HOME/lib" >> $GITHUB_ENV
+    - name: Install standard and test dependencies
+      run: pip install .[test]
 
-    - name: Install standard and test dependencies, then ocbpy for SSJ
-      if: ${{ matrix.install-extras == 2 }}
-      env:
-        CDF_LIB: $HOME/lib
-      run: |
-        pip install .[test]
-        bash requirements.extra ${{ matrix.install-extras }}
+    - name: Install extra dependencies
+      if: ${{ !startsWith(matrix.install-extras, 'base') }}
+      run: pip install .[${{ matrix.install-extras }}]
 
-    - name: Install standard and test dependencies, then ocbpy without SSJ
-      if: ${{ matrix.install-extras != 2 }}
+    - name: Set up pysat
+      if: startsWith(matrix.install-extras, 'pysat')
       run: |
-        pip install .[test]
-        bash requirements.extra ${{ matrix.install-extras }}
+        mkdir pysatData
+        python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"
 
     - name: Test PEP8 compliance
       run: flake8 . --count --show-source --statistics

Changelog.rst

@@ -3,6 +3,10 @@ Changelog
 
 Summary of all changes made since the first stable release
 
+0.5.0 (XX-XX-2024)
+------------------
+* DEP: Removed deprecated functions that depend on ssj_auroral_boundary package
+
 0.4.0 (06-07-2024)
 ------------------
 * DEP: Deprecated functions that depend on ssj_auroral_boundary package

docs/citing.rst

@@ -86,10 +86,9 @@ also includes fits to the R1 and R2 peaks, for those interested.
 DMSP SSJ Boundaries
 -------------------
 
-The DMSP SSJ boundaries are retrieved using
-`ssj_auroral_boundary <https://github.com/lkilcommons/ssj_auroral_boundary>`_.
-Please follow the citation guidelines on their page.  The general reference
-for the DMSP SSJ boundary data set is provided below.
+The archived DMSP SSJ boundaries are retrieved using
+`zenodo_get <https://github.com/dvolgyes/zenodo_get>`_.  The citations for the
+boundary method and data set are provided below.
 
 * **SSJ Auroral Boundaries**: Kilcommons, L. M., R. J. Redmon, and D. J. Knipp
   (2017), A new DMSP magnetometer and auroral boundary data set and estimates