Skip to content

Commit

Permalink
Merge pull request #8 from aburrell/develop
Browse files Browse the repository at this point in the history
Version 1.0.3 update
  • Loading branch information
Angeline Burrell committed Apr 6, 2018
2 parents 0164364 + 7708ddc commit 61a2447
Show file tree
Hide file tree
Showing 19 changed files with 545 additions and 369 deletions.
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.0.1
current_version = 1.0.3
commit = True
tag = False

Expand Down
15 changes: 4 additions & 11 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ language: python

python:
- '2.7'
- '3.3'
- '3.4'
- '3.5'
- '3.6'

sudo: false

Expand All @@ -15,30 +15,23 @@ addons:
- gfortran

env:

global:
LD_PRELOAD=/lib/x86_64-linux-gnu/libSegFault.so

matrix:
- TOXENV=extension-coveralls,coveralls,codecov
TESTSCRIPT="py.test --cov=apexpy --cov-report=term-missing"

- TOXENV=nocover
TESTSCRIPT="py.test"

before_install:
- python --version
- uname -a
- lsb_release -a
- pip install numpy

install:
- pip install coveralls pytest-cov coverage codecov
- python setup.py clean --all build_ext --force --inplace
- python setup.py develop
- pip install tox-travis

script:
$TESTSCRIPT

- tox
after_success:
- coverage combine
- coverage report
Expand Down
16 changes: 14 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,27 @@
Changelog
=========

1.0.3 (2018-04-05)
-----------------------------------------
* Updated badges and added DOI
* Added tests for python 3.6
* Removed tests for python 3.3
* Made some PEP8 changes

1.0.2 (2018-02-27)
-----------------------------------------

* Extend character limit for allowable data file path, and update documentation to reflect a change in maintainers. Also updated testing implimentation, reduced fortran compiler warnings, and improved PEP8 compliance.
* Extend character limit for allowable data file path, and update documentation
to reflect a change in maintainers. Also updated testing implimentation,
reduced fortran compiler warnings, and improved PEP8 compliance.

1.0.1 (2016-03-10)
-----------------------------------------

* Remove geocentric to geodetic conversion of subsolar point based on feedback from Art Richmond. (The subsolar point is the same in geocentric and geodetic coordinates.) The helper function `gc2gdlat` have been kept to preserve backwards compatibility.
* Remove geocentric to geodetic conversion of subsolar point based on feedback
from Art Richmond. (The subsolar point is the same in geocentric and geodetic
coordinates.) The helper function `gc2gdlat` have been kept to preserve
backwards compatibility.


1.0.0 (2015-11-30)
Expand Down
43 changes: 24 additions & 19 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,21 @@ Overview

|docs| |version|

This is a Python wrapper for the Apex fortran library by Emmert et al. [2010] [1]_, which allows converting between geodetic, modified apex, and quasi-dipole coordinates as well as getting modified apex and quasi-dipole base vectors (Richmond [1995] [2]_). MLT calculations are also included. The package is free software (MIT license).
This is a Python wrapper for the Apex fortran library by
Emmert et al. [2010] [1]_, which allows converting between geodetic, modified
apex, and quasi-dipole coordinates as well as getting modified apex and
quasi-dipole base vectors (Richmond [1995] [2]_). MLT calculations are also
included. The package is free software (MIT license).

Quick start
===========

Install (requires NumPy)::
Install (requires NumPy before installation)::

pip install apexpy

Conversion is done by creating an ``Apex`` object and using its methods to perform the desired calculations. Some simple examples::
Conversion is done by creating an ``Apex`` object and using its methods to
perform the desired calculations. Some simple examples::

>>> from apexpy import Apex
>>> from __future__ import print_function
Expand Down Expand Up @@ -78,36 +83,36 @@ Badges
:target: https://readthedocs.org/projects/apexpy
:alt: Documentation Status

.. |travis| image:: https://travis-ci.org/cmeeren/apexpy.svg?branch=master
.. |travis| image:: https://travis-ci.org/aburrell/apexpy.svg?branch=master
:alt: Travis-CI Build Status
:target: https://travis-ci.org/cmeeren/apexpy
:target: https://travis-ci.org/aburrell/apexpy

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/cmeeren/apexpy?branch=master&svg=true
.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/aburrell/apexpy?branch=master&svg=true
:alt: AppVeyor Build Status
:target: https://ci.appveyor.com/project/cmeeren/apexpy
:target: https://ci.appveyor.com/project/aburrell/apexpy

.. |requires| image:: https://requires.io/github/cmeeren/apexpy/requirements.svg?branch=master
.. |requires| image:: https://requires.io/github/aburrell/apexpy/requirements.svg?branch=master
:alt: Requirements Status
:target: https://requires.io/github/cmeeren/apexpy/requirements/?branch=master
:target: https://requires.io/github/aburrell/apexpy/requirements/?branch=master

.. |coveralls| image:: https://coveralls.io/repos/cmeeren/apexpy/badge.svg?branch=master&service=github
.. |coveralls| image:: https://coveralls.io/repos/github/aburrell/apexpy/badge.svg?branch=master
:alt: Coverage Status
:target: https://coveralls.io/github/cmeeren/apexpy
:target: https://coveralls.io/github/aburrell/apexpy?branch=master

.. |codecov| image:: https://codecov.io/github/cmeeren/apexpy/coverage.svg?branch=master
.. |codecov| image:: https://codecov.io/github/aburrell/apexpy/coverage.svg?branch=master
:alt: Coverage Status
:target: https://codecov.io/github/cmeeren/apexpy
:target: https://codecov.io/github/aburrell/apexpy

.. |landscape| image:: https://landscape.io/github/cmeeren/apexpy/master/landscape.svg?style=flat
:target: https://landscape.io/github/cmeeren/apexpy/master
.. |landscape| image:: https://landscape.io/github/aburrell/apexpy/master/landscape.svg?style=flat
:target: https://landscape.io/github/aburrell/apexpy/master
:alt: Code Quality Status

.. |codacy| image:: https://img.shields.io/codacy/af7fdf6be28841f283dfdbc1c01fa82a.svg?style=flat
:target: https://www.codacy.com/app/cmeeren/apexpy
:target: https://www.codacy.com/app/aburrell/apexpy
:alt: Codacy Code Quality Status

.. |codeclimate| image:: https://codeclimate.com/github/cmeeren/apexpy/badges/gpa.svg
:target: https://codeclimate.com/github/cmeeren/apexpy
:target: https://codeclimate.com/github/aburrell/apexpy
:alt: CodeClimate Quality Status
.. |version| image:: https://img.shields.io/pypi/v/apexpy.svg?style=flat
:alt: PyPI Package latest release
Expand All @@ -129,6 +134,6 @@ Badges
:alt: Supported implementations
:target: https://pypi.python.org/pypi/apexpy

.. |scrutinizer| image:: https://img.shields.io/scrutinizer/g/cmeeren/apexpy/master.svg?style=flat
.. |scrutinizer| image:: https://img.shields.io/scrutinizer/g/aburrell/apexpy/master.svg?style=flat
:alt: Scrutinizer Status
:target: https://scrutinizer-ci.com/g/cmeeren/apexpy/
:target: https://scrutinizer-ci.com/g/aburrell/apexpy/
36 changes: 20 additions & 16 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,6 @@ environment:
MINICONDA_HOME: C:\Miniconda
TESTSCRIPT: 'py.test'

- TESTENV: '3.3-nocover-64'
INSTALL_LIBPYTHON: libpython
PYTHON_VERSION: '3.3'
MINICONDA_HOME: C:\Miniconda-x64
TESTSCRIPT: 'py.test'

- TESTENV: '3.3-nocover-32'
INSTALL_LIBPYTHON: libpython
PYTHON_VERSION: '3.3'
MINICONDA_HOME: C:\Miniconda
TESTSCRIPT: 'py.test'

- TESTENV: '3.4-nocover-64'
INSTALL_LIBPYTHON: libpython
PYTHON_VERSION: '3.4'
Expand All @@ -51,6 +39,18 @@ environment:
MINICONDA_HOME: C:\Miniconda
TESTSCRIPT: 'py.test'

- TESTENV: '3.6-nocover-64'
INSTALL_LIBPYTHON: libpython
PYTHON_VERSION: '3.6'
MINICONDA_HOME: C:\Miniconda-x64
TESTSCRIPT: 'py.test'

- TESTENV: '3.6-nocover-32'
INSTALL_LIBPYTHON: libpython
PYTHON_VERSION: '3.6'
MINICONDA_HOME: C:\Miniconda
TESTSCRIPT: 'py.test'

- TESTENV: 'check'
INSTALL_LIBPYTHON: libpython
PYTHON_VERSION: '2.7'
Expand Down Expand Up @@ -78,14 +78,14 @@ install:
test_script:
- '%TESTSCRIPT%'

after_test:
- python setup.py sdist bdist_wheel

deploy_script:
# if tagged commit, build/upload wheel
- python setup.py bdist_wheel
- IF "%TESTENV%"=="2.7-nocover-64" (
python setup.py sdist
)
- IF "%APPVEYOR_REPO_TAG%"=="true" IF NOT "%TESTENV%"=="check" (
pip install twine &&
python setup.py register &&
twine upload -u %PYPI_USER% -p %PYPI_PASS% dist/*
)

Expand All @@ -94,6 +94,10 @@ artifacts:
matrix:
allow_failures:
- PYTHON_VERSION: '3.5'
- TESTENV: '2.7-nocover-64'
- TESTENV: '3.5-nocover-64'
- TESTENV: '3.6-nocover-64'
- TESTENV: 'check'
### To enable remote debugging uncomment this:
# - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))

17 changes: 5 additions & 12 deletions ci/templates/.travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ language: python

python:
- '2.7'
- '3.3'
- '3.4'
- '3.5'
- '3.6'

sudo: false

Expand All @@ -15,30 +15,23 @@ addons:
- gfortran

env:

global:
LD_PRELOAD=/lib/x86_64-linux-gnu/libSegFault.so

matrix:
- TOXENV=extension-coveralls,coveralls,codecov
TESTSCRIPT="py.test --cov=apexpy --cov-report=term-missing"

- TOXENV=nocover
TESTSCRIPT="py.test"

before_install:
- python --version
- uname -a
- lsb_release -a
- pip install numpy

install:
- pip install pytest-capturelog coveralls pytest-cov coverage codecov
- pip install coveralls pytest-cov coverage codecov
- python setup.py clean --all build_ext --force --inplace
- python setup.py develop
- pip install tox-travis

script:
$TESTSCRIPT

- tox
after_success:
- coverage combine
- coverage report
Expand Down
6 changes: 5 additions & 1 deletion ci/templates/appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ environment:
global:
WITH_COMPILER: 'cmd /E:ON /V:ON /C .\ci\appveyor-with-compiler.cmd'
matrix:
{% for env, config in tox_environments|dictsort %}{% if config.python in ('python2.6', 'python2.7', 'python3.3', 'python3.4', 'python3.5') and not config.cover %}
{% for env, config in tox_environments|dictsort %}{% if config.python in ('python2.6', 'python2.7', 'python3.4', 'python3.5', 'python3.6') and not config.cover %}
- TESTENV: '{{ env }}-64'
{%- if config.python != 'python3.5' %}

Expand Down Expand Up @@ -70,6 +70,10 @@ artifacts:
matrix:
allow_failures:
- PYTHON_VERSION: '3.5'
- TESTENV: '2.7-nocover-64'
- TESTENV: '3.5-nocover-64'
- TESTENV: '3.6-nocover-64'
- TESTENV: 'check'
### To enable remote debugging uncomment this:
# - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))

5 changes: 2 additions & 3 deletions ci/templates/tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,13 @@ passenv =
*
deps =
pytest
pytest-capturelog
sitepackages={env:TOX_USE_SITEPACKAGES:false}
numpy
skipsdist=True
commands =
# FIXME: --compiler=mingw32 will probably break travis, use envvars?
#conda install -q -p {toxworkdir}\{envdir} numpy
python setup.py clean --all build_ext --force --inplace
python setup.py develop
# python setup.py develop
{posargs:py.test -vv --ignore=src --doctest-glob='*.rst'}

[testenv:spell]
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
year = u'2015'
author = u'Christer van der Meeren, Angeline G. Burrell'
copyright = '{0}, {1}'.format(year, author)
version = release = u'1.0.1'
version = release = u'1.0.3'
# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

Expand Down
22 changes: 16 additions & 6 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,28 @@
Installation
============

This package requires NumPy, which you can install alone or as a part of SciPy. `Some Python distributions <http://www.scipy.org/install.html#scientific-python-distributions>`_ come with NumPy/SciPy pre-installed. For Python distributions without NumPy/SciPy, Windows/Mac users should install `pre-compiled binaries of NumPy/SciPy <http://www.scipy.org/scipylib/download.html#official-source-and-binary-releases>`_, and Linux users may have NumPy/SciPy available in `their repositories <http://www.scipy.org/scipylib/download.html#third-party-vendor-package-managers>`_.
This package requires NumPy, which you can install alone or as a part of SciPy.
`Some Python distributions <http://www.scipy.org/install.html#scientific-python-distributions>`_ come with NumPy/SciPy pre-installed. For Python distributions
without NumPy/SciPy, Windows/Mac users should install
`pre-compiled binaries of NumPy/SciPy <http://www.scipy.org/scipylib/download.html#official-source-and-binary-releases>`_, and Linux users may have NumPy/SciPy
available in `their repositories <http://www.scipy.org/scipylib/download.html#third-party-vendor-package-managers>`_.

When you have NumPy, install this package at the command line using ``pip`` [1]_::
When you have NumPy, install this package at the command line using
``pip`` [1]_::

pip install apexpy

On Linux this will build apexpy from source, which requires a fortran compiler such as gfortran.
On Linux this will build apexpy from source, which requires a fortran compiler
such as gfortran.

The package has been tested with the following setups (others might work, too):

* Windows (64 bit Python), Linux (64 bit), and Mac (64 bit)
* Python 2.7, 3.3 (also 32 bit Windows), 3.5 (and 3.4 on Linux/Mac [2]_)
* Python 2.7, 3.5, 3.6, (and 3.4 on Linux/Mac [2]_)

.. [1] pip is included with Python 2 from v2.7.9 and Python 3 from v3.4. If you don't have pip, `get it here <http://pip.readthedocs.org/en/stable/installing/>`_.
.. [2] I do not know how to compile the Fortran extension on Windows in a manner that is compatible with the omitted python versions. If you get it working, let me know!
.. [1] pip is included with Python 2 from v2.7.9 and Python 3 from v3.4.
If you don't have pip,
`get it here <http://pip.readthedocs.org/en/stable/installing/>`_.
.. [2] I do not know how to compile the Fortran extension on Windows in a
manner that is compatible with the omitted python versions. If you get
it working, let me know!
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,9 @@ multi_line_output=0

python_versions =
2.7
3.3
3.4
3.5
3.6

dependencies =
# 1.4: Django==1.4.16 !python_versions[3.*]
Expand Down

0 comments on commit 61a2447

Please sign in to comment.