Merge pull request #106 from pysat/rc_0.1.0

RC: 0.1.0

.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

.github/workflows/docs.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: 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@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r test_requirements.txt
+        pip install -r requirements.txt
+
+    - name: Set up pysat
+      run: |
+        mkdir pysatData
+        python -c "import pysat; pysat.params['data_dirs'] = 'pysatData'"
+
+    - 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,59 @@
+# 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: Pytest with Flake8
+
+on: [pull_request, push]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10"]
+        numpy_ver: [latest]
+        include:
+          - python-version: "3.8"
+            numpy_ver: "1.19"
+            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
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install standard dependencies
+      run: |
+        pip install -r test_requirements.txt
+        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=D,E,F,H,W --show-source --statistics
+
+    - name: Evaluate complexity
+      run: flake8 . --count --exit-zero --max-complexity=10 --statistics
+
+    - name: Run unit and integration tests
+      run: pytest --cov=pysatModels/
+
+    - name: Publish results to coveralls
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: coveralls --rcfile=setup.cfg --service=github

.gitignore

@@ -27,6 +27,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+docs/.build/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.zenodo.json

@@ -0,0 +1,31 @@
+{
+    "creators": [
+      {
+        "affiliation": "U.S. Naval Research Laboratory", 
+        "name": "Burrell, Angeline G.",
+        "orcid": "0000-0001-8875-9326"
+      }, 
+      {
+        "affiliation": "Goddard Space Flight Center",
+        "name": "Klenzing, Jeff",
+        "orcid": "0000-0001-8321-6074"
+      }, 
+      {
+        "affiliation": "Stoneris", 
+        "name": "Stoneback, Russell",
+        "orcid": "0000-0001-7216-4336"  
+      }
+    ],
+    "keywords": [
+	"Models",
+	"Model Validation",
+	"Validation",
+	"Comparison",
+	"Ionosphere",
+	"Thermosphere",
+	"TIE-CGM",
+	"SAMI2",
+	"Heliophysics",
+	"DINEOF"
+    ]
+}

CHANGELOG.md

@@ -1,6 +1,9 @@
-# Change Log
+Change Log
+==========
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
+This project adheres to [Semantic Versioning](https://semver.org/).
 
-## [0.1.0] - 2019-xx-xx
-- Initial release
+
+[0.1.0] - 2022-05-20
+--------------------
+* Initial release

CODE_OF_CONDUCT.md

@@ -5,9 +5,9 @@
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+size, disability, ethnicity, sex characteristics, gender identity and
+expression, level of experience, education, socio-economic status, nationality,
+personal appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
@@ -58,17 +58,19 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at pysat.developers@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct/
 
 [homepage]: https://www.contributor-covenant.org