Merge pull request #77 from aburrell/release_0.2

Release 0.2.0

.coveragerc

@@ -0,0 +1,22 @@
+[run]
+relative_files = True
+include = */ocbpy/*
+          */ocbpy/tests/*
+
+[paths]
+ocb_paths = ocbpy/
+            */lib/*/site-packages/ocbpy
+
+[report]
+omit = */lib/*/site-packages/*.py
+       */lib/*/site-packages/a*/*
+       */lib/*/site-packages/c*/*
+       */lib/*/site-packages/d*/*
+       */lib/*/site-packages/g*/*
+       */lib/*/site-packages/i*/*
+       */lib/*/site-packages/m*/*
+       */lib/*/site-packages/n*/*
+       */lib/*/site-packages/p*/*
+       */lib/*/site-packages/r*/*
+       */lib/*/site-packages/s*/*
+       */lib/*/site-packages/u*/*

.github/pull_request_template.md

@@ -0,0 +1,46 @@
+# Description
+
+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.rst`` for more guidelines.
+
+Fixes # (issue)
+
+## 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
+- Version number
+- Any details about your local setup that are relevant
+
+# Checklist:
+
+- [ ] Make sure you are merging into the ``develop`` (not ``main``) branch
+- [ ] My commits are formatted appropriately (following the SciPy/NumPy style) 
+- [ ] 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.rst``, summarising the changes
+- [ ] Add yourself to ``AUTHORS.rst``

.gitignore

@@ -6,6 +6,8 @@
 
 # Test directories
 /build/
+.tox
+.coverage
 
 # Setuptools distribution folder.
 /dist/
@@ -18,3 +20,7 @@
 docs/.build
 docs/.static
 docs/.templates
+
+# DMSP SSJ files
+ocbpy/boundaries/dmsp-ssj*.???
+ocbpy/boundaries/dmsp-f*.c??

.travis.yml

@@ -1,14 +1,43 @@
 language: python
 os:
     - linux
+
+env:
+    global:
+        - CDF_LIB=$HOME/lib
+        - COVERALLS_PARALLEL=true
+    jobs:
+        - INSTALL_EXTRA=0
+        - INSTALL_EXTRA=1
+        - INSTALL_EXTRA=2
 python:
-    - "2.7"
-    - "3.4"
-    - "3.5"
-    - "3.6"
+    - 2.7
+    - 3.5
+    - 3.6
+    - 3.7
+    - 3.8
+
+jobs:
+   allow_failures:
+      - env: INSTALL_EXTRA=1
+      - env: INSTALL_EXTRA=2
+addons:
+    apt_packages:
+        - gfortran
+        - gcc
+
+before_install:
+    - pip install -rrequirements.txt coveralls
+    - bash requirements.extra $INSTALL_EXTRA
+
 install:
-    - pip install coveralls
-    - "python setup.py install"
+    - python setup.py install
+
 script:
-    - "coverage run --source=ocbpy setup.py test"
-after_success: coveralls
+    - coverage run --rcfile=.coveragerc -m unittest discover
+
+after_success:
+    - coveralls --rcfile=.coveragerc
+
+notifications:
+  webhooks: https://coveralls.io/webhook

AUTHORS.rst

@@ -0,0 +1,11 @@
+Authors
+-------
+
+* Angeline G. Burrell - https://github.com/aburrell
+* Gareth Chisham
+* Jone P. Reistad - https://github.com/jpreistad
+
+Contributors
+------------
+
+* Dominic Jodoin - https://github.com/cotsog

CODE_OF_CONDUCT.rst

@@ -0,0 +1,82 @@
+Contributor Covenant Code of Conduct
+====================================
+
+Our Pledge
+----------
+
+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, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
+
+Our Standards
+-------------
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+Our Responsibilities
+--------------------
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+Scope
+-----
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an
+appointed representative at an online or offline event. Representation of a
+project may be further defined and clarified by project maintainers.
+
+Enforcement
+-----------
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. The
+project team will review and investigate all complaints, and will respond in a
+way that it deems 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.
+
+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]_.
+
+.. [homepage] http://contributor-covenant.org
+.. [1.4] http://contributor-covenant.org/version/1/4/

Changelog.rst

@@ -0,0 +1,9 @@
+Changelog
+=========
+
+Summary of all changes made since the first stable release
+
+
+0.2.0 (10-08-2020)
+------------------
+* First stable release

MANIFEST.in

@@ -1,7 +1,9 @@
 graft ocbpy/tests/test_data
 graft ocbpy/boundaries
 
+include AUTHORS.rst
 include README.md
 include License.md
 include CODE_OF_CONDUCT.md
-include CONTRIBUTING.rst
+include CONTRIBUTING.rst
+include Changelog.rst