v0.4.0

This release of ocbpy adds more AMPERE boundaries, enables vector transformations from geographic coordinates, deprecates the ssj_auroral_boundary package, and modernizes the package installation.

Change Summary

Deprecations

• Deprecated functions that depend on ssj_auroral_boundary
• Removed classes and kwargs deprecated in v0.3.0

Enhancements

• Added AMPERE OCBs up to 2022, using updated AMPERE data and added AMPERE EABs
• Allow data padding in pysat_instrument functions
• Separated vector transformations to support multiple coordinate systems
• Updated VectorData and pysat_instruments to allow geographic inputs

A full list of changes, including maintenance, testing, and bug fixes may be found in the changelog.

v0.3.0

This is a major update release to OCBpy, which introduces new functionality and changes some of the internal structure. OCBpy now supports gridding data in adaptive coordinates by both the open-closed field line boundary (OCB) and the equatorward auroral boundary (EAB). This improvement was made possible by new IMAGE boundaries, which are included in the package.

Change Summary

Bugs

• Fixed header initialization error in the general instrument loading routine
• Fixed the temporal cycling for SuperMAG data

Enhancements

• Updated the IMAGE OCB files and added the IMAGE EAB files
• Added classes for EAB and dual (OCB and EAB) boundary gridding
• Added a function to select data along a satellite track, improving usability of the DMSP SSJ boundaries
• Expanded the boundary correction options
• Made scaling optional for the SuperMAG and SuperDARN vorticity data

Deprecations

• Changed the format of the vector data stored in pysat Instruments
• Deprecated keyword arguments that are no longer needed to select quality IMAGE boundaries
• Moved the OCBoundary class , retrieve_all_good_indices function, and match_data_ocb function to new sub-modules

Maintenance

• Removed support for Python 2.7, 3.5, and 3.6; added support for Python 3.10
• Updated pysat integration to comply to latest standards

Documentation

• Updated citation
• Added more examples for different boundary types and data sources

v0.2.1

This is a bugfix release of OCBpy. It fixes an error in determining the sign and direction of vector data in OCB coordinates. This release supports Python 2.7-3.8.

Stable Release

This is the first stable release of OCBpy. It operates on multiple operating systems, contains multiple boundary data sets, has interfaces to be used with a variety of data sets, supports single and array inputs, and has documentation with examples for all major aspects of the code and citation guidelines for the various data sets. This will be the last release to support Python 2.7.

Beta Release

This release incorporates windows support and is available on pypi. The release is suitable for scientific data analysis, but has limited instrument support and there are still planned improvements to the documentation.

First release of OCBpy

Release of the alpha version of OCBpy. The release is suitable for scientific data analysis, but has limited instrument support, has not been tested on a large range of operating systems, and there are still planned improvements to the documentation.