Skip to content

Commit

Permalink
Merge 3f239de into e57449f
Browse files Browse the repository at this point in the history
  • Loading branch information
rstoneback committed May 4, 2022
2 parents e57449f + 3f239de commit 81681d9
Show file tree
Hide file tree
Showing 19 changed files with 816 additions and 419 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Version [e.g. 22]
- Other details about your setup that could be relevant

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
49 changes: 49 additions & 0 deletions .github/pull_request_template.md
@@ -0,0 +1,49 @@
# Description

Addresses #(issue)

Please include a summary of the change and which issue is fixed. Please also
include relevant motivation and context. List any dependencies that are required
for this change. Please see ``CONTRIBUTING.md`` for more guidelines.

## Type of change

Please delete options that are not relevant.

- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality
to not work as expected)
- This change requires a documentation update

# How Has This Been Tested?

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

**Test Configuration**:
* Operating system: Hal
* Version number: Python 3.X
* Any details about your local setup that are relevant: pysat version X

# Checklist:

- [ ] Make sure you are merging into the ``develop`` (not ``main``) branch
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] 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
- [ ] Update zenodo.json file for new code contributors

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
32 changes: 32 additions & 0 deletions .github/workflows/docs.yml
@@ -0,0 +1,32 @@
# 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: Load .zenodo.json to check for errors
run: python -c "import json; json.loads(open('.zenodo.json').read())"
56 changes: 56 additions & 0 deletions .github/workflows/main.yml
@@ -0,0 +1,56 @@
# 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.9", "3.10"]
os: [ubuntu-latest]
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 dependencies
run: |
python -m pip install --upgrade pip
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: 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: Install
run: python setup.py develop

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

- name: Publish results to coveralls
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: coveralls --rcfile=setup.cfg --service=github
51 changes: 0 additions & 51 deletions .travis.yml

This file was deleted.

35 changes: 35 additions & 0 deletions .zenodo.json
@@ -0,0 +1,35 @@
{
"creators": [
{
"affiliation": "Stoneris",
"name": "Stoneback, Russell",
"orcid": "0000-0001-7216-4336"
},
{
"affiliation": "The University of Texas at Dallas",
"name": "Depew, Matthew"
},
{
"affiliation": "Goddard Space Flight Center",
"name": "Klenzing, Jeffrey",
"orcid": "0000-0001-8321-6074"
},
{
"name": "Iyer, Gayatri"
},
{
"affiliation": "Predictive Science",
"name": "Pembroke, Asher"
},
{
"affiliation": "The Johns Hopkins Applied Physics Laboratory",
"name": "Starr, Greg",
"orcid": "0000-0002-3487-3630"
},
{
"affiliation": "SRI International",
"name": "Reimer, Ashton",
"orcid": "0000-0002-4621-3453"
}
]
}
22 changes: 22 additions & 0 deletions CHANGELOG.md
@@ -0,0 +1,22 @@
Change Log
==========
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/).

[0.3.2] - 2022-XX-XX
--------------------
* New Features
* Compatible with pysat v3.0+
* Deprecations
* Documentation
* Added pull request templates and other GitHub project documentation.
* Switched Windows installation instructions to favor installing WSL.
* Bug Fix
* Improved builds for newer compilers.
* Replaces uninterpretable characters with '*' so data loading may continue.
* Maintenance
* Adopted latest pysat development standards.
* Shifted from TravisCI to GitHub Actions for online testing.
* Adopted setup.cfg
* Improved PEP8 compliance

0 comments on commit 81681d9

Please sign in to comment.