Merge branch 'develop' into readthedocs

.travis.yml

@@ -1,21 +1,29 @@
 language: python
-python:
-  - "2.7"
-  - "3.4"
-  - "3.5"
-  - "3.6"
-sudo: false
+matrix:
+  include:
+    - python: 2.7
+    - python: 3.4
+    - python: 3.5
+    - python: 3.6
+    - python: 3.7
+      dist: xenial
+      sudo: true
 
 addons:
   apt:
     packages:
     - gfortran
 
 before_install:
+  - pip install coveralls
+  - pip install future
   - pip install matplotlib
 install:
   - source activate test-environment
   - python setup.py install
   - make -C sami2py/fortran compile
 script:
   - nosetests -vs --with-coverage --cover-package=sami2py
+
+after_success:
+  - coveralls

CONTRIBUTING.md

@@ -0,0 +1,98 @@
+Contributing
+============
+
+Bug reports, feature suggestions and other contributions are greatly
+appreciated!  Sami2py is a community-driven project and welcomes both feedback and
+contributions.
+
+Short version
+=============
+
+* Submit bug reports and feature requests through [GitHub](https://github.com/jklenzing/sami2py/issues)
+* Make pull requests to the ``develop`` branch
+
+Bug reports
+===========
+
+When [reporting a bug](https://github.com/jklenzing/sami2py/issues>) please
+include:
+
+* Your operating system name and version
+* Any details about your local setup that might be helpful in troubleshooting
+* Detailed steps to reproduce the bug
+
+Feature requests and feedback
+=============================
+
+The best way to send feedback is to file an issue at
+`GitHub <https://github.com/jklenzing/sami2py/issues>`_.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that code contributions
+  are welcome :)
+
+Development
+===========
+
+To set up `sami2py` for local development:
+
+1. [Fork sami2py on GitHub](https://github.com/jklenzing/sami2py/fork).
+2. Clone your fork locally
+
+::
+
+    git clone git@github.com:your_name_here/sami2py.git
+
+3. Create a branch for local development
+
+::
+
+    git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally. Tests for new instruments are
+   performed automatically.  Tests for custom functions should be added to the
+   appropriately named file in ``sami2py/tests``.   If no test file exists, then 
+   you should create one.  This testing uses nose, which will run tests on any 
+   python file in the test directory that starts with ``test_``.
+
+4. When you're done making changes, run all the checks to ensure that nothing
+   is broken on your local system
+
+::
+
+    nosetests -vs sami2py
+
+5. Update/add documentation (in ``docs``), if relevant
+
+5. Commit your changes and push your branch to GitHub
+
+::
+
+    git add .
+    git commit -m "Brief description of your changes"
+    git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website. Pull requests should be
+   made to the ``develop`` branch.
+
+Pull Request Guidelines
+-----------------------
+
+If you need some code review or feedback while you're developing the code, just
+make a pull request.
+
+For merging, you should:
+
+1. Include an example for use
+2. Add a note to ``CHANGELOG.md`` about the changes
+3. Ensure that all checks passed (current checks include Travis-CI
+   and Coveralls) [1]_
+
+.. [1] If you don't have all the necessary Python versions available locally or
+       have trouble building all the testing environments, you can rely on
+       Travis to run the tests for each change you add in the pull request.
+       Because testing here will delay tests by other developers, please ensure
+       that the code passes all tests on your local system first.

README.md

@@ -1,6 +1,6 @@
 # sami2py: sami2py is another model of the ionosphere python style
-
-[![Build Status](https://travis-ci.com/jklenzing/sami2py.svg?branch=master)](https://travis-ci.org/jklenzing/sami2py)
+[![Build Status](https://travis-ci.com/jklenzing/sami2py.svg?branch=develop)](https://travis-ci.com/jklenzing/sami2py)
+[![Coverage Status](https://coveralls.io/repos/github/jklenzing/sami2py/badge.svg?branch=develop)](https://coveralls.io/github/jklenzing/sami2py?branch=develop)
 [![Documentation Status](https://readthedocs.org/projects/sami2py/badge/?version=latest)](http://sami2py.readthedocs.io/en/latest/?badge=latest)
 
 # Overview
@@ -12,8 +12,6 @@ The implementation used here includes several added options to the original rele
  - The ability to switch between HWM93, HWM07, and HWM14 as a user option.
  This implementation is based on the version used in Klenzing et al [2013].
 
- The open-source fortran version of SAMI2 is found at https://www.nrl.navy.mil/ppd/branches/6790/sami2
-
 # Installation
 
 First, checkout the repository: