Release Candidate v1.1.0 #59

aburrell · 2021-02-23T21:05:14Z

Release candidate for version 1.1.0.

Summary of Changes

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

Release Checklist

Update the version number
Verify and update Zenodo information in .zeondo.json
doc tests pass locally
activate this branch on readthedocs: https://apexpy.readthedocs.io/en/rc_v1.1.0/index.html
Upload the test distribution to the testPyPi server: https://test.pypi.org/project/apexpy/
Contacted developers and users about the future release
Create a wiki page with the release text: https://github.com/aburrell/apexpy/wiki/v1.1.0
After approval, confirm all changes from the RC pull are listed in the wiki release text and the CHANGELOG.

Removed support for 3.3 and added support for 3.7.

Improved wheel logic so that no user specified environment variables are required.

Added comments containing two of the individual flags needed in comments and the general static flag as the real flag.

Improved error message

Changed static flag option since f2py doesn't use the makefile

This is giving travis coniption fits.

3.7 isn't ready for testing yet.

… is initialized properly for each test.

…g scheme of other methods.

Better error message for compilation problems.

[Feature] Ability to generate the magnetic field vector in apex coordinates.

IGRF coefficients are directly read from ASCII-file instead of using hard-coded values. This omits adding the coefficients manually in the future.

IGRF.f90 needs to be compiled first to make module available in linking.

Added some missing docstrings an simplified some tests.

Made a handful of PEP8 improvemeents and added a missing docstring.

Fixed unit tests that were failing on Travis due to a change in warning behaviour. Also added some missing docstrings and added more constraints to the unit tests under scrutiny.

Reverted style include whitespace around code pertaining to a block comment and ajusted line length.

Future-proofed the new doctrings.

Updated the changelog with a summary of updates in this pull request.

adding support for numpy.ndarray and numpy.datetime64 to helpers.subsol

modifying appveyor.yml, removing 3.4 and fix-compiler-error.py

… due to update to IGRF13

Improve robustness of unit tests for command line calls by ensuring access to apexpy on systems without the executable in the path.

Remove the extra whitespace before a comma.

Added a relative tolerance limit to `test_apxg2all` unit test.

Co-authored-by: Angeline Burrell <[email protected]>

[BUG]: Update apexshdat with IGRF13

asreimer

Just some polish-related comments and questions for the documentation. Otherwise it's looking good to me!

README.rst

docs/installation.rst

Fixed wording and spellings. Co-authored-by: Ashton Reimer <[email protected]>

docs/installation.rst

src/fortranapex/readme.txt

docs/installation.rst

Co-authored-by: Angeline Burrell <[email protected]>

asreimer · 2021-03-05T02:01:32Z

The only thing left to do now might be to test this:

pip install --global-option='build_ext' apexpy

on macOS to see if it works without the --no-use-pep517. Based on experience with Windows and Linux, without --no-use-pep517, it tries to build all of the dependencies listed in the pyproject.toml because:

Disabling all use of wheels due to the use of --build-option / --global-option / --install-option.

So it disables wheels even for the dependencies. If we want users to only rebuild the apexpy package, this seems to do that:

pip install --no-binary :apexpy: apexpy

Changing the docs to use the above command might be the way to go so we aren't implicitly asking users to compile Cython and numpy.

asreimer

After verifying the suspected issues with recommending:

pip install --global-option build_ext apexpy

to users, I updated the documentation to recommend:

pip install --no-binary :apexpy: apexpy

instead. I think this covers all the issues we had that are relevant to this release.

aburrell and others added 30 commits July 6, 2018 16:41

python versions

39cec22

Removed support for 3.3 and added support for 3.7.

wheel logic

ef30019

Improved wheel logic so that no user specified environment variables are required.

static makefile

4925b04

Added comments containing two of the individual flags needed in comments and the general static flag as the real flag.

error message

7843688

Improved error message

static flag option

6a51eef

Changed static flag option since f2py doesn't use the makefile

no more setup.py static

bd12bc2

This is giving travis coniption fits.

removed 3.7

adacefb

3.7 isn't ready for testing yet.

Added functionality for obtaining apex B vectors.

a1a51ea

Moved fa definition inside each test function so that fortran library…

a8649b1

… is initialized properly for each test.

Added tests for apex_bvectors and get_babs.

8a90304

Minor documentation update.

bd8ce68

Fix that allows ctypes to properly find the apex fortran library.

3bc2a40

Renamed apex_bvectors to bvectors_apex method so it aligns with namin…

fd6d337

…g scheme of other methods.

Merge pull request #13 from aburrell/static

5568621

Better error message for compilation problems.

Merge pull request #15 from aburrell/feature_add_get_B

94e63c3

[Feature] Ability to generate the magnetic field vector in apex coordinates.

Read IGRF coefficients from file

10358dc

IGRF coefficients are directly read from ASCII-file instead of using hard-coded values. This omits adding the coefficients manually in the future.

Makefile adjusted for igrf module

2079814

IGRF.f90 needs to be compiled first to make module available in linking.

adding support for numpy.ndarray and numpy.datetime64 to helpers.subsol

c41ebc7

adding support for numpy.ndarray and numpy.datetime64 to helpers.subsol

4db3faf

STY: added docstrings

f1ccae8

Added some missing docstrings an simplified some tests.

STY: improved PEP8

5bf0787

Made a handful of PEP8 improvemeents and added a missing docstring.

TST: fixed failing unit tests

be4fb56

Fixed unit tests that were failing on Travis due to a change in warning behaviour. Also added some missing docstrings and added more constraints to the unit tests under scrutiny.

STY: reverted style and added comments

ad0b0df

Reverted style include whitespace around code pertaining to a block comment and ajusted line length.

DOC: updated docstring style

46460ce

Future-proofed the new doctrings.

DOC: updated changelog

c605b73

Updated the changelog with a summary of updates in this pull request.

updated docstring for helpers.subsol and AUTHORS.rst

99f31ad

Merge pull request #29 from gregstarr/develop

4818ed2

adding support for numpy.ndarray and numpy.datetime64 to helpers.subsol

removing ctypes from apex.py, adding fortranapex.pyf, updating setup.py

c6566aa

modifying appveyor.yml, removing 3.4 and fix-compiler-error.py

248f05b

Merge pull request #1 from gregstarr/appveyor-fix

83d3e7e

modifying appveyor.yml, removing 3.4 and fix-compiler-error.py

asreimer and others added 11 commits February 25, 2021 23:24

[DOC] add instructions for updating apexsh.dat

1725417

[MNT]: updated expected outputs that changed by expected tiny amounts…

43d2d87

… due to update to IGRF13

[DOC]: updated expected output in examples

da62167

TST: improve cmd test robustness

6b9f3c2

Improve robustness of unit tests for command line calls by ensuring access to apexpy on systems without the executable in the path.

STY: removed extra whitespace

71279c8

Remove the extra whitespace before a comma.

TST: added relative tolerance

f80d7d5

Added a relative tolerance limit to `test_apxg2all` unit test.

DOC: fixing grammar

13a63e0

Co-authored-by: Angeline Burrell <[email protected]>

DOC: fixing grammar

1bf6d83

Co-authored-by: Angeline Burrell <[email protected]>

DOC: fixing grammar

399c3ac

Co-authored-by: Angeline Burrell <[email protected]>

DOC: typo

70b64b6

Merge pull request #64 from aburrell/bug_update_apexshdat

4a5b2d6

[BUG]: Update apexshdat with IGRF13

aburrell requested a review from asreimer March 1, 2021 19:47

asreimer mentioned this pull request Mar 2, 2021

[BUG]: pip install on windows failing #65

Closed

asreimer added 3 commits March 2, 2021 14:44

DOC: include quick install instructions for windows 10

6adc712

DOC: added win10 specific installation instructions

bd40c36

DOC: using pyproject.toml, so updated readme

39bc4ba

asreimer reviewed Mar 3, 2021

View reviewed changes

MAINT: improved documentation

ba2ad18

Fixed wording and spellings. Co-authored-by: Ashton Reimer <[email protected]>

aburrell commented Mar 3, 2021

View reviewed changes

aburrell requested a review from asreimer March 4, 2021 16:02

asreimer and others added 4 commits March 4, 2021 17:40

DOC: Update docs/installation.rst

bee098b

Co-authored-by: Angeline Burrell <[email protected]>

DOC: Update docs/installation.rst

31fec9f

Co-authored-by: Angeline Burrell <[email protected]>

DOC: Update src/fortranapex/readme.txt

a453754

Co-authored-by: Angeline Burrell <[email protected]>

DOC: Update docs/installation.rst

7d05562

Co-authored-by: Angeline Burrell <[email protected]>

asreimer added 2 commits March 4, 2021 22:41

DOC: simplified build instructions

b50ca4e

DOC: more accurate installation instructions

48ee3e6

asreimer approved these changes Mar 5, 2021

View reviewed changes

aburrell merged commit ba9c592 into main Mar 5, 2021

aburrell deleted the rc_v1.1.0 branch March 5, 2021 21:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release Candidate v1.1.0 #59

Release Candidate v1.1.0 #59

aburrell commented Feb 23, 2021 •

edited

Loading

asreimer left a comment

asreimer commented Mar 5, 2021 •

edited

Loading

asreimer left a comment

Release Candidate v1.1.0 #59

Release Candidate v1.1.0 #59

Conversation

aburrell commented Feb 23, 2021 • edited Loading

Summary of Changes

Release Checklist

asreimer left a comment

Choose a reason for hiding this comment

asreimer commented Mar 5, 2021 • edited Loading

asreimer left a comment

Choose a reason for hiding this comment

aburrell commented Feb 23, 2021 •

edited

Loading

asreimer commented Mar 5, 2021 •

edited

Loading