Skip to content

Commit

Permalink
Merge pull request #13 from aburrell/develop
Browse files Browse the repository at this point in the history
Version 2.4.0 Release
  • Loading branch information
Angeline Burrell authored Mar 21, 2018
2 parents 3ec635f + cd970fa commit e4d4aa4
Show file tree
Hide file tree
Showing 96 changed files with 8,499 additions and 5,389 deletions.
4 changes: 2 additions & 2 deletions .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[bumpversion]
current_version = 2.0.0
current_version = 2.4.0
commit = True
tag = True

[bumpversion:file:setup.py]

[bumpversion:file:docs/conf.py]

[bumpversion:file:src/aacgmv2/__init__.py]
[bumpversion:file:aacgmv2/__init__.py]

2 changes: 1 addition & 1 deletion .codeclimate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ languages:
Python: true
exclude_paths:
- "ci/"
- "tests/"
- "aacgmv2/tests/"
- "docs/"
- "setup.py"
14 changes: 7 additions & 7 deletions .cookiecutterrc
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@ default_context:
command_line_interface: 'no'
coveralls: 'yes'
distribution_name: 'aacgmv2'
email: '[email protected]'
full_name: 'Christer van der Meeren'
github_username: 'cmeeren'
email: '[email protected]'
full_name: 'Angeline G. Burrell'
github_username: 'aburrell'
landscape: 'yes'
package_name: 'aacgmv2'
project_name: 'AACGM-v2 Python library'
project_short_description: '"A Python wrapper for AACGM-v2 magnetic coordinates"'
release_date: '2015-06-10'
release_date: '2018-03-12'
repo_name: 'aacgmv2'
requiresio: 'yes'
scrutinizer: 'yes'
sphinx_theme: 'readthedocs'
test_matrix_configurator: 'yes'
test_runner: 'pytest'
travis: 'yes'
version: '0.1.0'
website: 'https://github.com/cmeeren/aacgmv2'
year: '2015'
version: '2.0.1'
website: 'https://github.com/aburrell/aacgmv2'
year: '2018'
8 changes: 6 additions & 2 deletions .coveragerc
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
[paths]
source = src
source =
aacgmv2
c_aacgmv2

[run]
branch = True
source = src
source =
aacgmv2
c_aacgmv2
parallel = true

[report]
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ pip-log.txt
.coverage
.tox
.coverage.*
.pytest_cache
nosetests.xml
coverage.xml
htmlcov
Expand Down
2 changes: 1 addition & 1 deletion .landscape.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ doc-warnings: yes
ignore-paths:
- docs
- ci
- tests
- aacgmv2/tests
- setup.py
52 changes: 12 additions & 40 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,54 +1,26 @@
language: python
python: '3.5'
python:
- "2.7"
- "3.4"
- "3.5"
- "3.6"
sudo: false
env:
global:
LD_PRELOAD=/lib/x86_64-linux-gnu/libSegFault.so
matrix:
- TOXENV=check
- TOXENV=2.7-np1.10,extension-coveralls,coveralls
- TOXENV=2.7-np1.10-nocover
- TOXENV=2.7-np1.8,extension-coveralls,coveralls
- TOXENV=2.7-np1.8-nocover
- TOXENV=2.7-np1.9,extension-coveralls,coveralls
- TOXENV=2.7-np1.9-nocover
- TOXENV=3.3-np1.10,extension-coveralls,coveralls
- TOXENV=3.3-np1.10-nocover
- TOXENV=3.3-np1.8,extension-coveralls,coveralls
- TOXENV=3.3-np1.8-nocover
- TOXENV=3.3-np1.9,extension-coveralls,coveralls
- TOXENV=3.3-np1.9-nocover
- TOXENV=3.4-np1.10,extension-coveralls,coveralls
- TOXENV=3.4-np1.10-nocover
- TOXENV=3.4-np1.8,extension-coveralls,coveralls
- TOXENV=3.4-np1.8-nocover
- TOXENV=3.4-np1.9,extension-coveralls,coveralls
- TOXENV=3.4-np1.9-nocover
- TOXENV=3.5-np1.10,extension-coveralls,coveralls
- TOXENV=3.5-np1.10-nocover
- TOXENV=3.5-np1.8,extension-coveralls,coveralls
- TOXENV=3.5-np1.8-nocover
- TOXENV=3.5-np1.9,extension-coveralls,coveralls
- TOXENV=3.5-np1.9-nocover
before_install:
- python --version
- uname -a
- lsb_release -a
install:
- pip install tox
- virtualenv --version
- easy_install --version
- pip --version
- tox --version
- pip install coveralls
- "python setup.py install"
- pip install tox-travis
script:
- tox -v
after_failure:
- more .tox/log/* | cat
- more .tox/*/log/* | cat
- tox
- coverage run --source aacgmv2 -m py.test
after_sucess: coveralls
notifications:
email:
on_success: never
on_failure: always
matrix:
allow_failures:
- env: "TOXENV=check"
on_failure: always
3 changes: 2 additions & 1 deletion AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
Authors
=======

* Christer van der Meeren - https://github.com/cmeeren
* Angeline G. Burrell - https://github.com/aburrell
* Christer van der Meeren
* Karl M. Laundal
12 changes: 12 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@
Changelog
=========

2.4.0 (2017-03-21)
-----------------------------------------

* Update to use AACGM-v2.4, which includes changes to the inverse MLT and
dipole tilt functions and some minor bug fixes
* Updated file structure
* Updated methods, retaining old methods in deprecated module
* Added testing for python 3.6
* Updated dependencies, removing support for python 3.3
* Tested on Mac OSX
* Updated comments to include units for input and output

2.0.0 (2016-11-03)
-----------------------------------------

Expand Down
41 changes: 28 additions & 13 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,21 @@
Contributing
============

Bug reports, feature suggestions and other contributions are greatly appreciated! While I can't promise to implement everything, I will always try to respond in a timely manner.
Bug reports, feature suggestions and other contributions are greatly
appreciated! While I can't promise to implement everything, I will always try
to respond in a timely manner.

Short version
=============

* Submit bug reports and feature requests at `GitHub <https://github.com/cmeeren/aacgmv2/issues>`_
* Submit bug reports and feature requests at `GitHub <https://github.com/aburrell/aacgmv2/issues>`_
* Make pull requests to the ``develop`` branch

Bug reports
===========

When `reporting a bug <https://github.com/cmeeren/aacgmv2/issues>`_ please include:
When `reporting a bug <https://github.com/aburrell/aacgmv2/issues>`_ please
include:

* Your operating system name and version
* Any details about your local setup that might be helpful in troubleshooting
Expand All @@ -22,20 +25,22 @@ When `reporting a bug <https://github.com/cmeeren/aacgmv2/issues>`_ please inclu
Feature requests and feedback
=============================

The best way to send feedback is to file an issue at `GitHub <https://github.com/cmeeren/aacgmv2/issues>`_.
The best way to send feedback is to file an issue at
`GitHub <https://github.com/aburrell/aacgmv2/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 :)
* Remember that this is a volunteer-driven project, and that code contributions
are welcome :)

Development
===========

To set up `aacgmv2` for local development:

1. `Fork aacgmv2 on GitHub <https://github.com/cmeeren/aacgmv2/fork>`_.
1. `Fork aacgmv2 on GitHub <https://github.com/aburrell/aacgmv2/fork>`_.
2. Clone your fork locally::

git clone [email protected]:your_name_here/aacgmv2.git
Expand All @@ -44,9 +49,16 @@ To set up `aacgmv2` for local development:

git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally. Add tests for bugs and new features in ``tests/test_py_aacgmv2.py`` (for the wrapper), ``test_c_aacgmv2.py`` (for the C extension), or ``tests/test_cmd_aacgmv2.py`` (for the command-line interface). The tests are run with ``py.test`` and can be written as normal functions (starting with ``test_``) containing a standard ``assert`` statement for testing output.
Now you can make your changes locally. Add tests for bugs and new features
in ``tests/test_py_aacgmv2.py`` (for the wrapper), ``test_c_aacgmv2.py``
(for the C extension), or ``tests/test_cmd_aacgmv2.py`` (for the
command-line interface). ``tests/test_dep_aacgmv2.py`` includes tests for
deprecated functions. The tests are run with ``py.test`` and can be
written as normal functions (starting with ``test_``) containing a standard
``assert`` statement for testing output, or use the numpy testing suite.

4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.org/en/latest/install.html>`_ [1]_::
4. When you're done making changes, run all the checks, doc builder and spell
checker with `tox <http://tox.readthedocs.org/en/latest/install.html>`_ [1]_::

tox

Expand All @@ -56,12 +68,14 @@ To set up `aacgmv2` for local development:
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.
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.
If you need some code review or feedback while you're developing the code, just
make a pull request.

For merging, you should:

Expand All @@ -70,9 +84,10 @@ For merging, you should:
3. Add a note to ``CHANGELOG.rst`` about the changes
4. Add yourself to ``AUTHORS.rst``

.. [1] If you don't have all the necessary Python versions available locally or have trouble
building NumPy in all the testing environments, you can rely on Travis and
AppVeyor - they will run the tests for each change you add in the pull request.
.. [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 and AppVeyor - they will run the tests for each change you add in
the pull request.
Tips
----
Expand Down
28 changes: 28 additions & 0 deletions LICENSE-AstAlg.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Copyright and License Information

This source file is part of a library of files implementing
portions of the algorithms given in the book _Astronomical
Algorithms_ by Jean Meeus.

Software Copyright (C) 2006, U.S. Government
Author: Kile B. Baker
National Science Foundation
4201 Wilson Blvd,
Arlington, VA 22230
email: [email protected]

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


11 changes: 7 additions & 4 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
graft docs
graft examples
graft src
graft ci
graft tests
graft aacgmv2/tests
graft c_aacgmv2

recursive-include aacgmv2 *.asc
recursive-include aacgmv2 *.txt

include .bumpversion.cfg
include .coveragerc
Expand All @@ -14,8 +16,9 @@ include AUTHORS.rst
include CHANGELOG.rst
include CONTRIBUTING.rst
include LICENSE
include LICENSE-AstAlg.txt
include README.rst

include tox.ini .travis.yml appveyor.yml .codeclimate.yml .landscape.yaml

global-exclude *.py[cod] __pycache__ *.so *.dylib
global-exclude *.py[cod] __pycache__ *.so *.dylib *.dSYM .pytest_cache
Loading

0 comments on commit e4d4aa4

Please sign in to comment.