Merge pull request #111 from pysat/tst/ga_standards

.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.10"]  # 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__)"

.github/workflows/pysat_rc.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: ["macos-latest", "ubuntu-latest", "windows-latest"]
         python-version: ["3.10"]
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
@@ -23,7 +23,7 @@ jobs:
         python-version: ${{ matrix.python-version }}
 
     - name: Install pysat RC
-      run: pip install --no-deps -i https://test.pypi.org/simple/ pysat
+      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: |

CHANGELOG.md

@@ -2,12 +2,13 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/).
 
-## [0.X.X] - 2022-XX-XX
+## [0.X.X] - 2023-XX-XX
 * Maintenance
   * Update pytest syntax
   * Update Github Actions versions
   * Add manual GitHub Actions tests for pysat RC
   * Add manual GitHub Actions tests for optional dependencies
+  * Add manual GitHub Actions tests for pysatMissions RC
   * Remove optional dependencies in readthedocs requirements
   * Add tests for NEP 29 testing
   * Add tests for Mac OS

docs/conf.py

@@ -81,7 +81,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/references.rst

@@ -15,7 +15,7 @@ accessing the Altitude-Adjusted Corrected Geomagnetic (AACGM) coordinates.
   9139–9143.
 * Shepherd, S. G. (2014). Altitude−adjusted corrected geomagnetic coordinates:
   Definition and functional approximations. Journal of Geophysical Research:
-  Space Physics, 119, 7501–7521. https://doi.org/10.1002/2014JA020264
+  Space Physics, 119, 7501–7521. DOI: 10.1002/2014JA020264
 
 apexpy
 ------
@@ -31,7 +31,7 @@ calculating magnetic apex coordinates.
 * Emmert, J. T., Richmond, A. D., & Drob, D. P. (2010). A computationally
   compact representation of magnetic-apex and quasi-dipole coordinates with
   smooth base vectors. Journal of Geophysical Research, 115, A08322.
-  https://doi.org/10.1029/2010JA015326
+  DOI: 10.1029/2010JA015326
 * Laundal, K. M., & Richmond, A. D. (2017). Magnetic coordinate systems. Space
   Science Reviews, 206, 27–59