Contributing

Bug reports, feature suggestions and other contributions are greatly appreciated! While I can’t promise to implement everything, I will always try to respond in a timely manner.

Short version

  • Submit bug reports and feature requests at GitHub

  • Make pull requests to the develop branch

Bug reports

When reporting a bug please include:

  • Your operating system name and version

  • Any details about your local setup that might be helpful in troubleshooting

  • Detailed steps to reproduce the bug

Feature requests and feedback

The best way to send feedback is to file an issue at GitHub.

If you are proposing a feature:

  • Explain in detail how it would work.

  • Keep the scope as narrow as possible, to make it easier to implement.

  • Remember that this is a volunteer-driven project, and that code contributions are welcome :)

Development

To set up ocbpy for local development:

  1. Fork ocbpy on GitHub.

  2. Clone your fork locally:

    git clone git@github.com:your_name_here/ocbpy.git

  3. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally. Add tests for bugs and new features into the ocbpy/tests/ directory, either in the appropriately named file (for changes to an existing file) or in a new file (that should share the name of the new file, prepended by test_. The tests use unittest. Changes or additions to the documentation (located in docs) should also be made at this time.

  4. When you’re done making changes, run the tests locally before submitting a pull request

  5. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Brief description of your changes"
git push origin name-of-your-bugfix-or-feature

  6. Submit a pull request through the GitHub website. Pull requests should be made to the develop branch.

Pull Request Guidelines

If you need some code review or feedback while you’re developing the code, just make a pull request.

Do not merge any pull requests, the local maintainer is in charge of merging until this project grows.

Tips

To run a subset of tests from the test directory for a specific environment:

python -m unittest test_name.py

To run all the tests for a specific environment:

python -m unittest discover

Contributor Covenant Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language

  • Being respectful of differing viewpoints and experiences

  • Gracefully accepting constructive criticism

  • Focusing on what is best for the community

  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances

  • Trolling, insulting/derogatory comments, and personal or political attacks

  • Public or private harassment

  • Publishing others’ private information, such as a physical or electronic address, without explicit permission

  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at angeline.g.burrell.civ@us.navy.mil. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant [homepage], version [1.4].

Changelog

Summary of all changes made since the first stable release

0.6.0 (07-07-2025)

  • ENH: Updated the AMPERE boundaries to include 2022-2024, inclusive

  • ENH: Added to_dict method to the boundary class objects

  • ENH: Added Starkov (1994) auroral model

  • ENH: Adapted boundary classes to accept model boundaries

  • BUG: Supported newest version of zenodo_get, which underwent breaking changes

0.5.0 (01-28-2025)

  • DEP: Removed deprecated functions that depend on ssj_auroral_boundary package

  • DEP: Removed deprecated methods, attributes, and kwargs in VectorData

  • DOC: Added data reference for SuperDARN vorticity data

  • BUG: Fixed load_vorticity_ascii_data to correctly cycle through files

  • BUG: Fixed EAB index pairing issue in DualBoundary class

  • BUG: Fixed zenodo-get import in pyproject.toml

  • TST: Updated GitHub Actions yamls

  • MAINT: Cycled Python and pysat version support

0.4.0 (06-07-2024)

  • DEP: Deprecated functions that depend on ssj_auroral_boundary package

  • DEP: Removed classes and kwargs deprecated in v0.3.0

  • MAINT: Cycled supported Python versions

  • MAINT: Added a pyproject.toml file and removed setup.py

  • MAINT: Updated numpy logic to address DeprecationWarnings

  • MAINT: Updated GitHub Action yamls to use pyproject.toml and cycle versions

  • MAINT: Updated GitHub Action yamls to use coveralls-reporter

  • ENH: Added AMPERE OCBs up to 2022, using updated AMPERE data

  • ENH: Added AMPERE EABs, using the Heppner-Maynard boundary as a valid EAB

  • ENH: Changed default directory ID to use pathlib

  • ENH: Allow data padding in pysat_instrument functions

  • ENH: Separated vector transformations to support multiple coordinate systems

  • ENH: Updated VectorData and pysat_instruments to allow geographic inputs

  • BUG: Fixed a typo in the documentation’s pysat example

  • BUG: Added an error catch for badly formatted SuperMAG file reading

  • BUG: Fixed the flat/zero masking for vector pole angles with array input

  • TST: Added a new CI test for the Test PyPi Release Candidate

  • TST: Reduced duplication by creating a common test class and test variable

  • TST: Added a ReadTheDocs yaml

  • DOC: Improved docstring style compliance and correctness

  • DOC: Updated pysat example to use geodetic inputs and improve the EAB plot

0.3.0 (10-21-2022)

  • BUG: Fixed header initialization error general instrument loading routine

  • BUG: Fixed time cycling in the supermag2ascii_ocb function

  • DEP: Moved OCBoundary class to hidden sub-module, _boundary

  • DEP: Moved ocboundary functions to new sub-module, cycle_boundary

  • DEP: Deprecated kwargs no longer needed to select good IMAGE data

  • DEP: Changed the format for vector data stored in pysat Instruments

  • DOC: Improved the PEP8 and numpydoc compliance in the documentation examples

  • DOC: Updated citations

  • DOC: Updated cross-referencing and added missing API sections

  • DOC: Added examples for DMSP SSJ boundaries, pysat Instruments, and the

    DualBoundary class, updated the README example

  • DOC: Improved documentation configuration

  • ENH: Added a setup configuration file

  • ENH: Changed class __repr__ to produce a string eval can use as input

  • ENH: Updated the IMAGE OCB files and added EAB files

  • ENH: Added EAB and dual-boundary classes

  • ENH: Added function to select data along a satellite track

  • ENH: Changed attributes in VectorData into properties to ensure expected

    behaviour if altering the class data after initialisation

  • ENH: Added IMAGE SI12, SI13, and WIC DMSP corrections to harmonic

  • ENH: Made scaling optional for SuperMAG and SuperDARN vorticity data

  • MAINT: Removed support for Python 2.7, 3.5, and 3.6; added support for 3.10

  • MAINT: Improved PEP8 compliance

  • MAINT: Updated pysat routines to v3.0.0 standards

  • MAINT: Updated CDF installation

  • MAINT: Removed now-unnecessary logic in unit tests for Windows OS

  • REL: Added a .zenodo.json file

  • TST: Integrated and removed Requires.io; it requires a payed plan for GitHub

  • TST: Added flake8 and documentation tests to CI

  • TST: Moved all configurations to setup.cfg, removing .coveragecfg

  • TST: Improved test coverage, specifically adding pysat xarray tests and

    expanding unit tests for __repr__ methods

  • TST: Migrated to GitHub Actions from Travis CI and Appveyor

0.2.1 (11-24-2020)

  • DOC: Updated examples in README

  • BUG: Fixed an error in determining the sign and direction of OCB vectors

  • STY: Changed a ValueError in VectorData to logger warning

0.2.0 (10-08-2020)

  • First stable release