Skip to content

Commit

Permalink
Merge pull request #141 from sami2py/rc0.2.3
Browse files Browse the repository at this point in the history
Release Candidate 0.2.3
  • Loading branch information
jklenzing committed Jun 16, 2021
2 parents 3bd2728 + c890177 commit 3c0b866
Show file tree
Hide file tree
Showing 31 changed files with 816 additions and 300 deletions.
32 changes: 0 additions & 32 deletions .appveyor.yml

This file was deleted.

3 changes: 0 additions & 3 deletions .flake8

This file was deleted.

40 changes: 40 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# 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: Manually install sami2py
run: python setup.py install --user

- 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())"
65 changes: 65 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# 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: [push, pull_request]

jobs:
build:

strategy:
fail-fast: false
matrix:
python-version: [3.8, 3.9]
numpy_ver: [latest]
os: [ubuntu-latest, windows-latest]
include:
- python-version: 3.7
numpy_ver: 1.17
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 latest dependencies
if: ${{ matrix.numpy_ver == 'latest'}}
run: |
python -m pip install --upgrade pip
pip install -r test_requirements.txt
pip install -r requirements.txt
pip install numpy --upgrade;
- name: Install NEP29 dependencies
if: ${{ matrix.numpy_ver != 'latest'}}
run: |
python -m pip install --upgrade pip
pip install -r test_requirements.txt
pip install -r requirements.txt
pip install --no-binary :numpy: numpy==${{ matrix.numpy_ver }};
- name: Manually install sami2py
run: python setup.py install --user

- name: Test PEP8 compliance
run: flake8 . --count --select=E,F,W --show-source --statistics

- name: Evaluate complexity
run: flake8 . --count --exit-zero --max-complexity=10 --statistics

- name: Test with pytest
run: pytest --cov=sami2py/

- name: Publish results to coveralls
if: ${{ matrix.os == 'ubuntu-latest'}}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: coveralls --rcfile=setup.cfg --service=github

- uses: codecov/codecov-action@v1
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*.o
*.x
*.mod
sami2py/fortran/ExB.inp
sami2py/fortran/exb.inp
sami2py/fortran/sami2py-1.00.namelist

.DS_STORE
Expand Down
50 changes: 0 additions & 50 deletions .travis.yml

This file was deleted.

38 changes: 38 additions & 0 deletions .zenodo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"creators": [
{
"affiliation": "Goddard Space Flight Center",
"name": "Klenzing, Jeff",
"orcid": "0000-0001-8321-6074"
},
{
"affiliation": "Catholic University of America, Goddard Space Flight Center",
"name": "Smith, Jonathon M.",
"orcid": "0000-0002-8191-4765"
},
{
"affiliation": "American University",
"name": "Kitano, Reika"
},
{
"affiliation": "Boston University",
"name": "Hirsch, Michael",
"orcid": "0000-0002-1637-6526"
},
{
"affiliation": "U.S. Naval Research Laboratory",
"name": "Burrell, Angeline G.",
"orcid": "0000-0001-8875-9326"
},
{
"name": "zzyztyy"
}
],
"access_right": "open",
"resource_type": [
{
"type": "software",
"title": "Software"
}
]
}
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,35 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.2.3] - 2021-06-16
- Updated Variable and dataset attributes for netcdf export
- Updated netcdf file in test_data
- Added default drift fourier coefficient array accessible from run model
- Using minimum test version of numpy in accordance with NEP 29
- Removed the sami2py-1.00.namelist and version.txt files from run_name
- Bug Fix
- Pull version info from a single location
- fixed a bug in compiling readthedocs
- added default exb file: setup.py generates a exb.inp file
- Use integer for longitude in directory structure
- Improved windows compatibility
- Added ability to input custom ExB Drifts as a Fourier Series
- return_fourier function in utils.py
- plot_exb function in _core_class.py
- Testing return_fourier function in test_utils.py
- Added ability to generate Fourier Coefficients from time series ExB drifts
- fourier_fit function in utils.py
- private __make_fourier function in utils.py
- Testing fourier_fit function in test_utils.py
- scipy dependency added
- Added default exb file: setup.py generates a exb.inp file
- Added deprecation warnings to plotting functions
- Adjusted output step size in model to more closely match desired cadence
- Migrated CI testing to Github Actions
- Documentation
- Added zenodo integration
- Improved maintainability of conf.py

## [0.2.2] - 2020-07-17
- Added simple port of core data to netcdf file
- Increased unformatted test data to 6 time steps
Expand Down
2 changes: 1 addition & 1 deletion License.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2019, Jeff Klenzing (JK) and Joe Huba (JH)
Copyright (c) 2021, sami2py development team
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
16 changes: 6 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,19 @@ sami2py: sami2py is another model of the ionosphere python style
:stub-columns: 1

* - docs
- | |docs| |doi|
- | |rtd| |doi|
* - tests
- | |travis| |appveyor|
- | |pytest|
| |coveralls| |codecov|
| |codeclimate|
.. |docs| image:: https://readthedocs.org/projects/sami2py/badge/?version=latest
.. |rtd| image:: https://readthedocs.org/projects/sami2py/badge/?version=latest
:target: http://sami2py.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. |travis| image:: https://travis-ci.com/sami2py/sami2py.svg?branch=main
:target: https://travis-ci.com/sami2py/sami2py
:alt: Documentation Status

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/j36b7x15e2nu1884?svg=true
:target: https://ci.appveyor.com/project/jklenzing/sami2py
:alt: Documentation Status
.. |pytest| image:: https://github.com/sami2py/sami2py/actions/workflows/main.yml/badge.svg
:target: https://github.com/sami2py/sami2py/actions/workflows/main.yml
:alt: Pytest with Flake8

.. |coveralls| image:: https://coveralls.io/repos/github/sami2py/sami2py/badge.svg?branch=main
:target: https://coveralls.io/github/sami2py/sami2py?branch=main
Expand Down

0 comments on commit 3c0b866

Please sign in to comment.