Skip to content

Conversation

@aburrell
Copy link
Owner

@aburrell aburrell commented Jul 1, 2025

Description

This is a release that adds major new functionality and expanded data boundaries.

  • Updated AMPERE boundaries to include 2022-2024
  • Added an empirical model of auroral boundaries and adapted boundary classes to use model input
  • Added a to_dict method to the boundary class objects to facilitate the creation of data files with the boundaries.
  • Fixed bugs introduced by upstream changes to optional dependencies.

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)
  • This change requires a documentation update

How Has This Been Tested?

Added new unit tests and examples. Recommend running the model and save boundary examples in the documentation.

Test Configuration

  • Operating system: OS X Big Sur
  • Version number: Python 3.10
  • Any details about your local setup that are relevant: zenodo-get v2.0.0

Checklist:

  • Update the version number
  • Verify and update Zenodo information in .zenodo.json
  • doc tests pass locally
  • Upload the test distribution to the testPyPi server
  • Contacted developers and users about the future release
  • My commits are formatted appropriately (following the SciPy/NumPy style)
  • 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

aburrell and others added 30 commits June 7, 2024 12:09
Fixed typo in changelog.
Removed deprecated functions that relied on `ssj_auroral_boundaries`.
Removed unit tests for deprecated functions that have been removed.
Updated the citation guidelines for the DMSP SSJ data.
Added a summary of the changes to the changelog.
Removed the deprecated dependency for DMSP SSJ data.
Removed the extras testing support file.
Updated test yamls to use pyproject.toml instead of the requirements.extras file.
Removed the tab from the yaml file.
Removed unneeded environment variable definition for CDF files.
Updated the yaml text evaluation.
Fix string evaluation and add the missing pysat setup section.
Update the zenodo-get installation name.
Updated the failure message for the DMSP SSJ function.
Updated `test_fetch_format_ssj_boundary_files_no_rm_temp` to check for a zip archive instead of CDF files.
DEP: removed support for `dmsp_ssj_boundaries`
Removed the deprecated attributes, methods, and kwargs in the VectorData class.
Removed the tests for the deprecated portions of the VectorData class.
Update the changelog with new aspects of this pull request and portions of the previous pull request.
Fixed a bug that incorrectly cycled file lines.  Also:
- added reference for the vorticity data, and
- updated failure type from logging error to IOError.
Updated the vorticity failure tests to identify the new failure type.
Added a summary of the changes to the changelog.
Added a criteria that the EAB index cannot be larger than the maximum valid value.
Added a unit test that verifies the maximum OCB and EAB indices are not larger than the largest valid value.  Adjusted custom test to reflect new results with this new safeguard in place.
Updated the changelog to include this bugfix.
Updated the minimum and maximum supported Python and pysat versions.
Removed Python 3.9 from and added Python 3.13 to the CI tests.
aburrell added 24 commits June 30, 2025 11:17
Added a citation for the Starkov model.
Added a model example to the documentation.
Added a model initialization example to the documentation.
Added the ellipses to the expected example output.
Added a section to hold the boundary models in the docs.
Ensure all co-latitudes have a realistic lower limit.
Added unit tests for the Starkov functions.
Added test for the different boundary classes with model initialization and loading.
Fixes ellipses to only appear of there are records that are not shown in the printed representation.
Updated the class display to include ellipses.
Fixed the documentation typing for python text.
Added members section to automodule.
Fixed the use of references in the models docstring.
Added support for breaking changes made in newest version of zenodo_get.
Added a summary of the changes to the changelog.
The DMSP autodoc is not working correctly on RTD, try installing zenodo-get.
Update the RDT yaml to use the most recent version of Python.
Removed a trailing whitespace from a comment.
The way checksum and output messages are used differs by version, fixed to use the method that required the least amount of changes.
Update version number and description.
Set a target release date for next week.
@aburrell aburrell added this to the v0.6.0 milestone Jul 1, 2025
@aburrell
Copy link
Owner Author

aburrell commented Jul 1, 2025

Cannot release until the file size upload issue with PyPi is resolved: pypi/support#6816

@coveralls
Copy link

coveralls commented Jul 1, 2025

Coverage Status

coverage: 99.65% (-0.1%) from 99.752%
when pulling b9e8196 on rc_0.6.0
into 43ce9c9 on main.

@aburrell aburrell merged commit 460c826 into main Aug 11, 2025
112 of 116 checks passed
@aburrell aburrell deleted the rc_0.6.0 branch August 11, 2025 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants