RC V2.7.0 #93

aburrell · 2024-12-27T21:17:04Z

Description

This is a release that updates the coefficients for IGRF-14 and also contains the new version of the C code, 2.7. Deprecated functions have been removed.

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
Breaking change (fix or feature that would cause existing functionality
to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Ran unit tests locally after updating them for new behaviour.

Test Configuration:

Operating system: OS X Ventura
Version number: Python 3.10
Any details about your local setup that are relevant: gcc 14.2.0

Checklist:

RC v2.6.3

Added a RTD yaml file at the default location.

Moved all the doc requirements to the pyproject.toml file.

Added a summary of the changes to the changelog.

Fixed a bug where the old requirements file was used in the docs test. Updated main test to import test requirements from pyproject.toml.

Updated call to napoleon sphinx extension.

Removed an extra period, introduced as a typo.

Added a version limit for the sphinx RTD theme.

Read The Docs update

Updated the AACGMV2 coefficient files for IGRF 14.

Updated the IGRF coefficient file to IGRF-14.

Transitioned more parts of the setup.cfg file into the pyproject.toml file. Also updated the supported Python versions.

Updated the CI tests to: - cover new Python versions, - update the coveralls execution, and - use the pyproject.toml for installation and reference.

Updated the Python version used in the documentation tests.

Updated the magmodel coefficient file.

Updated the init file to use importlib packages, get the version dynamically from the pyproject.toml, and change the IGRF coefficient file back to the magmodel file.

Updated the C source documentation: the README and release notes.

Updated the AACGMV2 headers for version 2.7.

Updated the C code to version 2.7.

Updated the README to reflect the new C version.

Removed the deprecated source file (routine now lives in rtime.c).

Removed bad lines and formatting from pyproject.toml.

Update the list of source files in the setup.py file.

Added instructions for updating the Python code for IGRF and new C versions.

Updated the documentation configuration file to use the pyproject.toml for version information.

Updated the supported Python versions in the docs.

Update the test values for the new AACGMV2 coefficients.

Update the documentation to include a list of expected tests that need to be updated with new coefficients.

Updated the changelog with changes, a new version number, and a target release date.

Added a missing package for documentation configuration.

Updated my email in the code of conduct.

Fixed broken links and references.

Fixed the sublist formatting for the list of tests that need to be updated.

More fixes to the docstring style.

Remove an old keyword from the coverage specifications.

Added init files for the unit tests.

Be extra careful about imports when testing the environment.

Added a more detailed error message to a test.

Updated the module structure after adding init files.

Removed pytest flags that are no longer necessary.

Updated test logic to handle the different MacOS python support options.

Added the numpy version to the run names.

Fixed a typo in the numpy version variable name.

IGRF-14 and C 2.7 update

Removed the module containing the deprecated functions.

Removed the tests for deprecated functions and updated the structure tests. Fixed bugs in the structure test docstrings.

Updated the documentation index depth.

Update the changelog to include changes made here.

Remove deprecated functions

Updated the version in preparation for release.

coveralls · 2024-12-27T21:21:18Z

Pull Request Test Coverage Report for Build 12520790390

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+1.1%) to 93.73%

Totals
Change from base Build 4125745284:	1.1%
Covered Lines:	1095
Relevant Lines:	1165

💛 - Coveralls

aburrell · 2024-12-27T21:40:26Z

@dchaddock, @MITHaystack, @JouleCai, @indiajacksonphd, @sapols, @KCollins, @dchaddock, @mattkjames7, @mshumko, @HamSCI, @jklenzing, @aalekseevx, and @zemarchezi. Each of you have actively developed projects that depend on the most recent version of AACGMV2. If you would like, here's the release candidate you can test out. If you have any issues, feel free to let me know.

I am going to try and get this out before the new year to prevent any issues with realtime processing in AAGCMV2 coordinates due to the IGRF-14 update.

jklenzing · 2024-12-30T19:13:50Z

Updated my RC tests in github actions here. Tests are successfully running with the RC as a dependency, however I am getting the following warning from aacgmv2: DeprecationWarning: path is deprecated. Use files() instead. Refer to https://importlib-resources.readthedocs.io/en/latest/using.html#migrating-from-legacy for migration advice. Not sure if this is expected in this release.

EDIT: just realized this is coming from importlib-resources when aacgmv2 is imported.

jklenzing

Overall looks good. A few minor comments on things that could just be written up as issues for a future release.

jklenzing · 2024-12-30T19:51:06Z

aacgmv2/__init__.py

+    _os.path.split(str(resources.path(__package__,
+                                      '__init__.py').__enter__()))[0],
+    'aacgm_coeffs', 'aacgm_coeffs-14-')
+IGRF_COEFFS = _os.path.join(
+    _os.path.split(str(resources.path(__package__,
+                                      '__init__.py').__enter__()))[0],
+    'magmodel_1590-2025.txt')


These are the lines that generate the Deprecation Warning. resources.path is replaced by resources.files. Probably worth an issue for the next update.

jklenzing · 2024-12-30T19:57:21Z

setup.cfg

-
-[aliases]
-release = register clean --all sdist
+version = 2.7.0


I think you could drop the duplicate metadata here since python 3.9 is the minimum supported version.

aburrell and others added 30 commits February 8, 2023 10:51

Merge pull request #84 from aburrell/rc_v2.6.3

dedbe3d

RC v2.6.3

ENH: added RTD yaml

ba62c1a

Added a RTD yaml file at the default location.

MAINT: moved doc requirements

c79622b

Moved all the doc requirements to the pyproject.toml file.

DOC: updated changelog

e2ef713

Added a summary of the changes to the changelog.

BUG: updated test imports

236147b

Fixed a bug where the old requirements file was used in the docs test. Updated main test to import test requirements from pyproject.toml.

BUG: updated conf.py

c9be254

Updated call to napoleon sphinx extension.

BUG: removed extra period

2853079

Removed an extra period, introduced as a typo.

BUG: added version limit

8c8da27

Added a version limit for the sphinx RTD theme.

Merge pull request #86 from aburrell/rtd_update

e8d5bd9

Read The Docs update

MAINT: updated coefficient files

4b62016

Updated the AACGMV2 coefficient files for IGRF 14.

MAING: updated IGRF coefficient file

042ff41

Updated the IGRF coefficient file to IGRF-14.

MAINT: updated pyproject.toml

dbdbf97

Transitioned more parts of the setup.cfg file into the pyproject.toml file. Also updated the supported Python versions.

TST: updated CI tests

843bfa9

Updated the CI tests to: - cover new Python versions, - update the coveralls execution, and - use the pyproject.toml for installation and reference.

TST: updated the doc tests

ab55046

Updated the Python version used in the documentation tests.

MAINT: updated the magmodel file

fb63f88

Updated the magmodel coefficient file.

STY: updated init

91136ea

Updated the init file to use importlib packages, get the version dynamically from the pyproject.toml, and change the IGRF coefficient file back to the magmodel file.

MAINT: updated C documentation

c48eee7

Updated the C source documentation: the README and release notes.

MAINT: updated AACGMV2 headers

cb93fbc

Updated the AACGMV2 headers for version 2.7.

MAINT: updated C code

ad1d7b8

Updated the C code to version 2.7.

DOC: updated README

244aec7

Updated the README to reflect the new C version.

MAINT: removed deprecated file

715781c

Removed the deprecated source file (routine now lives in rtime.c).

BUG: removed bad lines

8e0eb0d

Removed bad lines and formatting from pyproject.toml.

MAINT: update source file list

e095959

Update the list of source files in the setup.py file.

DOC: added maintenance instructions

c3c41d0

Added instructions for updating the Python code for IGRF and new C versions.

MAINT: updated doc configuration

cd9fdd5

Updated the documentation configuration file to use the pyproject.toml for version information.

MAINT: updated Python versions in docs

2ca7160

Updated the supported Python versions in the docs.

TST: update reference test values

ebcad36

Update the test values for the new AACGMV2 coefficients.

DOC: update docs to include tests

d8c2c90

Update the documentation to include a list of expected tests that need to be updated with new coefficients.

DOC: updated changelog

6ee976c

Updated the changelog with changes, a new version number, and a target release date.

BUG: added missing package

11a1730

Added a missing package for documentation configuration.

aburrell added 20 commits December 27, 2024 14:30

DOC: updated primary email

6d2fe32

Updated my email in the code of conduct.

DOC: fixed broken links

bc0a684

Fixed broken links and references.

STY: fix indented list

51f7950

Fixed the sublist formatting for the list of tests that need to be updated.

DOC: improved docstring style

57b6fee

More fixes to the docstring style.

BUG: remove bad keyword

725607f

Remove an old keyword from the coverage specifications.

TST: added missing init files

ab35ee0

Added init files for the unit tests.

BUG: ensure clean environment

d8373a2

Be extra careful about imports when testing the environment.

TST: improved error message

124d6e4

Added a more detailed error message to a test.

TST: updated the structure

805b2b9

Updated the module structure after adding init files.

MAINT: removed pytest flags

cafd11a

Removed pytest flags that are no longer necessary.

BUG: mac OS testing

de642ae

Updated test logic to handle the different MacOS python support options.

BUG: fixed run name uniqueness

4b8cd81

Added the numpy version to the run names.

BUG: fixed typo

884e2cf

Fixed a typo in the numpy version variable name.

Merge pull request #90 from aburrell/igrf14_update

772e96b

IGRF-14 and C 2.7 update

DEP: removed deprecated function module

02905c0

Removed the module containing the deprecated functions.

TST: removed tests for deprecated functions

e5c9bca

Removed the tests for deprecated functions and updated the structure tests. Fixed bugs in the structure test docstrings.

STY: updated index depth

ccc055d

Updated the documentation index depth.

DOC: update changelog

8855c19

Update the changelog to include changes made here.

Merge pull request #92 from aburrell/remove_dep

f7cdda7

Remove deprecated functions

REL: version bump

91810c8

Updated the version in preparation for release.

aburrell added this to the v2.7.0 milestone Dec 27, 2024

jklenzing mentioned this pull request Dec 30, 2024

BUG/TST: Fix external RC tests, add mac testing, bump NEP29 numpy pysat/pysatMissions#124

Merged

11 tasks

jklenzing reviewed Dec 30, 2024

View reviewed changes

aburrell requested a review from jklenzing December 31, 2024 14:27

jklenzing approved these changes Dec 31, 2024

View reviewed changes

aburrell merged commit 2c25565 into main Dec 31, 2024
48 checks passed

aburrell deleted the v2.7.0_rc branch December 31, 2024 15:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RC V2.7.0 #93

RC V2.7.0 #93

aburrell commented Dec 27, 2024 •

edited

Loading

coveralls commented Dec 27, 2024

aburrell commented Dec 27, 2024

jklenzing commented Dec 30, 2024 •

edited

Loading

jklenzing left a comment

jklenzing Dec 30, 2024

aburrell Dec 31, 2024

jklenzing Dec 30, 2024

aburrell Dec 31, 2024

RC V2.7.0 #93

RC V2.7.0 #93

Conversation

aburrell commented Dec 27, 2024 • edited Loading

Description

Type of change

How Has This Been Tested?

Checklist:

coveralls commented Dec 27, 2024

Pull Request Test Coverage Report for Build 12520790390

Details

💛 - Coveralls

aburrell commented Dec 27, 2024

jklenzing commented Dec 30, 2024 • edited Loading

jklenzing left a comment

Choose a reason for hiding this comment

jklenzing Dec 30, 2024

Choose a reason for hiding this comment

aburrell Dec 31, 2024

Choose a reason for hiding this comment

jklenzing Dec 30, 2024

Choose a reason for hiding this comment

aburrell Dec 31, 2024

Choose a reason for hiding this comment

aburrell commented Dec 27, 2024 •

edited

Loading

jklenzing commented Dec 30, 2024 •

edited

Loading