Merge pull request #116 from aburrell/rc_0.3.0

Release Candidate 0.3.0

.github/pull_request_template.md

@@ -22,13 +22,16 @@ Please describe the tests that you ran to verify your changes. Provide
 instructions so we can reproduce. Please also list any relevant details for
 your test configuration
 
-- [ ] Test A
-- [ ] Test B
+```
+import ocbpy
+# Do a thing
+```
 
-**Test Configuration**:
-- Operating system
-- Version number
-- Any details about your local setup that are relevant
+## Test Configuration
+
+- Operating system: (Hal)
+- Version number: (Python 1.0)
+- Any details about your local setup that are relevant: (e.g., pysat version)
 
 # Checklist:
 
@@ -43,4 +46,4 @@ 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.rst``, summarising the changes
-- [ ] Add yourself to ``AUTHORS.rst``
+- [ ] Add yourself to ``AUTHORS.rst`` and ``.zenodo.json``

.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+# This workflow will run doc tests for a single Python version. For more
+# information see:
+# https://help.github.com/actions/language-and-framework-guides/
+# using-python-with-github-actions
+
+
+name: Documentation Check
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    name: Documentation tests
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Set CDF Lib environment variable
+      run: echo "CDF_LIB=$HOME/lib" >> $GITHUB_ENV
+
+    - name: Install standard and test dependencies, then ocbpy
+      run: |
+        pip install -r docs/requirements.txt sphinx sphinx_rtd_theme numpydoc
+        bash requirements.extra 2
+        python setup.py install
+
+    - name: Check documentation build
+      run: sphinx-build -E -b html docs dist/docs
+
+    - name: Check documentation links
+      run: sphinx-build -b linkcheck docs dist/docs
+
+    - name: Load .zenodo.json to check for errors
+      run: python -c "import json; json.loads(open('.zenodo.json').read())"

.github/workflows/main.yml

@@ -0,0 +1,84 @@
+# 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: unittest with flake8
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        install-extras: [0, 1, 2]
+        exclude:
+          - os: windows-latest
+            install-extras: 2
+
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }} with extras ${{ matrix.install-extras }}
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      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, then ocbpy for SSJ
+      if: ${{ matrix.install-extras == 2 }}
+      env:
+        CDF_LIB: $HOME/lib
+      run: |
+        pip install -r requirements.txt
+        bash requirements.extra ${{ matrix.install-extras }}
+        python setup.py install
+
+    - name: Install standard and test dependencies, then ocbpy without SSJ
+      if: ${{ matrix.install-extras != 2 }}
+      run: |
+        pip install -r requirements.txt
+        bash requirements.extra ${{ matrix.install-extras }}
+        python setup.py install
+
+    - name: Test PEP8 compliance
+      run: flake8 . --count --show-source --statistics
+
+    - name: Evaluate complexity
+      run: flake8 . --count --exit-zero --max-complexity=10 --statistics
+
+    - name: Run unit and integration tests
+      run: coverage run --rcfile=setup.cfg -m unittest discover
+
+    - name: Publish results to coveralls upon success
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        COVERALLS_PARALLEL: true
+        COVERALLS_FLAG_NAME: run-${{ matrix.python-version }}-${{ matrix.os }}-${{ matrix.install-extras }}
+      run: coveralls --rcfile=setup.cfg --service=github || true
+
+  finish:
+    needs: build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Coveralls Finished
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          pip install --upgrade coveralls
+          coveralls --service=github --finish || true

.zenodo.json

@@ -0,0 +1,36 @@
+{
+    "license": {
+      "id": "bsd-license"
+    },
+    "keywords": [
+	"magnetic coordinates", 
+	"coordinate-transformation", 
+	"coordinate-systems", 
+	"space", 
+	"space-physics", 
+	"ionosphere", 
+	"magnetosphere",
+	"Conversion",
+	"Coordinate Conversion", 
+	"Converting",
+	"Magnetic Field",
+	"Space Physics",
+	"Heliophysics"
+    ],
+    "creators": [
+      {
+        "orcid": "0000-0001-8875-9326", 
+        "affiliation": "Naval Research Laboratory", 
+        "name": "Angeline G. Burrell"
+      },
+      {
+        "orcid": "0000-0003-1151-5934", 
+        "affiliation": "British Antarctic Survey", 
+        "name": "Gareth Chisham"
+      },
+      {
+        "affiliation": "Birkeland Centre for Space Science", 
+        "name": "Jone Reistad"
+      }
+    ]
+}

CODE_OF_CONDUCT.md

@@ -42,5 +42,5 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

CODE_OF_CONDUCT.rst

@@ -78,5 +78,5 @@ Attribution
 This Code of Conduct is adapted from the Contributor Covenant [homepage]_,
 version [1.4]_.
 
-.. [homepage] http://contributor-covenant.org
-.. [1.4] http://contributor-covenant.org/version/1/4/
+.. [homepage] https://contributor-covenant.org
+.. [1.4] https://contributor-covenant.org/version/1/4/

Changelog.rst

@@ -3,6 +3,42 @@ Changelog
 
 Summary of all changes made since the first stable release
 
+0.3.0 (10-21-2022)
+------------------
+* BUG: Fixed header initialization error general instrument loading routine
+* BUG: Fixed time cycling in the `supermag2ascii_ocb` function
+* DEP: Moved OCBoundary class to hidden sub-module, `_boundary`
+* DEP: Moved `ocboundary` functions to new sub-module, `cycle_boundary`
+* DEP: Deprecated kwargs no longer needed to select good IMAGE data
+* DEP: Changed the format for vector data stored in pysat Instruments
+* DOC: Improved the PEP8 and numpydoc compliance in the documentation examples
+* DOC: Updated citations
+* DOC: Updated cross-referencing and added missing API sections
+* DOC: Added examples for DMSP SSJ boundaries, pysat Instruments, and the
+       DualBoundary class, updated the README example
+* DOC: Improved documentation configuration
+* ENH: Added a setup configuration file
+* ENH: Changed class `__repr__` to produce a string `eval` can use as input
+* ENH: Updated the IMAGE OCB files and added EAB files
+* ENH: Added EAB and dual-boundary classes
+* ENH: Added function to select data along a satellite track
+* ENH: Changed attributes in VectorData into properties to ensure expected
+       behaviour if altering the class data after initialisation
+* ENH: Added IMAGE SI12, SI13, and WIC DMSP corrections to `harmonic`
+* ENH: Made scaling optional for SuperMAG and SuperDARN vorticity data
+* MAINT: Removed support for Python 2.7, 3.5, and 3.6; added support for 3.10
+* MAINT: Improved PEP8 compliance
+* MAINT: Updated pysat routines to v3.0.0 standards
+* MAINT: Updated CDF installation
+* MAINT: Removed now-unnecessary logic in unit tests for Windows OS
+* REL: Added a .zenodo.json file
+* TST: Integrated and removed Requires.io; it requires a payed plan for GitHub
+* TST: Added flake8 and documentation tests to CI
+* TST: Moved all configurations to setup.cfg, removing .coveragecfg
+* TST: Improved test coverage, specifically adding pysat xarray tests and
+       expanding unit tests for `__repr__` methods
+* TST: Migrated to GitHub Actions from Travis CI and Appveyor
+
 0.2.1 (11-24-2020)
 ------------------
 * DOC: Updated examples in README

MANIFEST.in

@@ -1,10 +1,8 @@
 graft ocbpy/tests/test_data
 graft ocbpy/boundaries
 
-include AUTHORS.rst
-include README.md
-include License.md
-include CODE_OF_CONDUCT.md
-include CODE_OF_CONDUCT.rst
-include CONTRIBUTING.rst
-include Changelog.rst
+include *.rst
+include *.md
+
+include *.yml
+include .zenodo.json