Merge pull request #59 from aburrell/rc_v1.1.0

Release Candidate v1.1.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,8 +1,8 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
-labels: ''
+title: 'BUG: '
+labels: 'bug'
 assignees: ''
 
 ---
@@ -25,8 +25,9 @@ If applicable, add screenshots to help explain your problem.
 
 **Computer (please complete the following information):**
  - OS: [e.g. iOS]
- - Version [e.g. 22]
-- Python version [e.g. 3.6]
+ - Python version [e.g. 3.6]
+ - Compiler with version [e.g., gfortran 47]
+ - Apexpy version/branch [e.g., 1.1.0]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,26 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'ENH: '
+labels: 'enhancement'
+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.  Keep the scope as
+narrow as possible, to make it easier to implement
+
+**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.  For context, the apexpy version/branch you're working on, your system detail, your python version, and your compiler (with version) may or may not be relevant.
+
+**Reminders**
+This is a volunteer-driven project.  Code contributions are welcome, as is help
+testing new code.

.github/ISSUE_TEMPLATE/question.md

@@ -1,8 +1,8 @@
 ---
 name: Question
 about: Ask a question (and help us improve our documentation)
-title: ''
-labels: ''
+title: 'Question: '
+labels: 'question'
 assignees: ''
 
 ---
@@ -25,8 +25,9 @@ If applicable, add screenshots to help explain your question.
 
 **Desktop (please complete the following information):**
  - OS: [e.g. iOS]
- - Version [e.g. 22]
  - Python version [e.g. 3.6]
+ - Compiler with version [e.g., gfortran 22]
+ - Apexpy version/branch [e.g., 1.1.0]
 
 **Additional context**
 Add any other context about the problem here.

.github/pull_request_template.md

@@ -0,0 +1,47 @@
+# 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
+- Release candidate
+
+# 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: (e.g., Hal)
+* Python version number: (e.g., 3.7)
+* Compiler with version number: (e.g. gfortran 9.0)
+* Any details about your local setup that are relevant (e.g., apexpy version/branch)
+
+# 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.rst``, summarising the changes
+- [ ] Add yourself to ``AUTHORS.rst`` and ``.zenodo.json``

.gitignore

@@ -92,3 +92,8 @@ docs/_build
 *.exe
 *.out
 *.app
+
+# Local f2py wrappers
+src/fortranapex/fortranapex-f2pywrappers.f*
+src/fortranapex/fortranapex-f2pywrappers2.f*
+src/fortranapex/fortranapexmodule.c

.travis.yml

@@ -1,10 +1,11 @@
 language: python
 
 python:
-  - '2.7'
-  - '3.4'
-  - '3.5'
-  - '3.6'
+  - "2.7"
+  - "3.6"
+  - "3.7"
+  - "3.8"
+  - "3.9"
 
 sudo: false
 
@@ -22,22 +23,21 @@ before_install:
   - python --version
   - uname -a
   - lsb_release -a
-  - pip install numpy
+  - pip install numpy coveralls pytest-cov tox-travis
 
 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
+  - python setup.py install
 
 script:
-  - tox
+  - |
+    if [ $TRAVIS_PYTHON_VERSION == "3.7" ]; then
+        tox -e docs
+    fi
+  - tox -e $TRAVIS_PYTHON_VERSION
+
 after_success:
-  - coverage combine
-  - coverage report
-  - coveralls --merge=extension-coveralls.json []
-  - coveralls
-  - codecov
+  - coveralls --rcfile=setup.cfg
 
 notifications:
   email:

.zenodo.json

@@ -0,0 +1,51 @@
+{
+  "license": {
+  "id": "MIT"
+  }, 
+  "notes": "When referencing this package, please cite both the package DOI and the Apex Coordinates journal article: Emmert, J. T., A. D. Richmond, and D. P. Drob (2010), A computationally compact representation of Magnetic-Apex and Quasi-Dipole coordinates with smooth base vectors, J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.",
+  "references": [
+    "Emmert, J. T., A. D. Richmond, and D. P. Drob (2010), A computationally compact representation of Magnetic-Apex and Quasi-Dipole coordinates with smooth base vectors, J. Geophys. Res., 115(A8), A08322, doi:10.1029/2010JA015326.",
+    "Richmond, A. D. (1995), Ionospheric Electrodynamics Using Magnetic Apex Coordinates, Journal of geomagnetism and geoelectricity, 47(2), 191–212, doi:10.5636/jgg.47.191."
+  ], 
+  "keywords": [
+    "Magnetic Apex Coordinates",
+    "Quasi Dipole Coordinates",
+    "MLT", 
+    "Magnetic Local Time", 
+    "Conversion", 
+    "Coordinate Conversion", 
+    "Converting", 
+    "Ionosphere", 
+    "Magnetic Field", 
+    "Space Physics", 
+    "Heliophysics"
+  ], 
+  "creators": [
+    {
+      "orcid": "0000-0002-8043-0953", 
+      "name": "Christer van der Meeren"
+    },
+    {
+      "orcid": "0000-0001-5028-4943",
+      "name": "Karl M. Laundal"
+    },
+    {
+      "orcid": "0000-0001-8875-9326", 
+      "affiliation": "Naval Research Laboratory", 
+      "name": "Angeline G. Burrell"
+    },
+    {
+      "orcid": "0000-0002-3487-3630",
+      "name": "Gregory Starr"
+    },
+    {
+      "orcid": "0000-0002-4621-3453",
+      "name": "Ashton S. Reimer"
+    },
+    {
+      "orcid": "0000-0001-7955-4441",
+      "affiliation": "GFZ German Research Centre for Geosciences",
+      "name": "Achim Morschhauser"
+    }
+  ]
+}

AUTHORS.rst

@@ -7,7 +7,9 @@ This python wrapper is made by:
 * Karl M. Laundal
 * Christer van der Meeren
 * Angeline G. Burrell (maintainer)
+* Gregory Starr
 * Ashton Reimer
+* Achim Morschhauser
 
 Fortran code by Emmert et al. [2010] [1]_. Quasi-dipole and modified
 apex coordinates are defined by Richmond [1995] [2]_. The code uses

CHANGELOG.rst

@@ -2,6 +2,19 @@
 Changelog
 =========
 
+1.1.0 (2021-03-05)
+------------------
+* Adapted Fortran to read IRGF coefficients from a file (updated to IGRF-13)
+* Improved the subsol routine to allow array input
+* Improved PEP8 compliance
+* Added some missing docstrings to unit tests
+* Fixed AppVeyor test environment
+* Updated python test versions
+* Updated community and package documentation
+* Fixed bug where NaNs caused array input to crash
+* Fixed bug in quasi-dipole to apex conversion at equator
+* Removed duplicate CI services
+
 1.0.4 (2019-04-05)
 ----------------------------------------
 * Updated installation instructions