Skip to content

Latest commit

 

History

History
90 lines (59 loc) · 2.53 KB

CHANGE_LOG.rst

File metadata and controls

90 lines (59 loc) · 2.53 KB

PlasmaPy Change Log

This document provides a detailed list of changes associated with each release of PlasmaPy. The [release notes](https://github.com/PlasmaPy/PlasmaPy/blob/master/RELEASE_NOTES.md) contain a narrative description for each version.

Version 0.1.0 (2018-03-xx)

Version 0.1.0 is the initial development release of PlasmaPy. This version is a prototype and a preview, and is not feature complete. Significant changes to the API are expected to occur between versions 0.1.0 and 0.2.0.

New Features

  • The vision statement describes the motivation of early PlasmaPy developers in creating a fully open source Python package for plasma physics.
  • Added a code of conduct.
  • Added a contribution guide.
  • Adopted a BSD 3-clause license and added protections against software patents.
  • Set up continuous integration testing with Travis CI, CircleCI, and AppVeyor, along with test coverage checks with Coveralls.
  • Decided upon code and docstring style conventions and set up automated code style checks with pep8speaks.
  • Set up automated documentation builds with Sphinx that are hosted on Read the Docs.
  • Adopted use of astropy.units as a units package. Allowed import of units as import plasmapy.units as u.
  • Created the atomic subpackage to provide easy access to commonly used atomic data.
    • Created functional interface to access particle properties and find the energy released from nuclear reactions.
    • Created Particle class.
    • Created @particle_input decorator.
  • Created classes subpackage with the Plasma and Species classes.
  • Created constants subpackage.
  • Created mathematics subpackage with functionality commonly used in plasma physics.
  • Created physics subpackage to calculate plasma parameters, transport coefficients, collision rates, and relativity/quantum physics parameters used in plasma physics.
  • Created utils subpackage.
    • Created @check_quantity and @check_relativistic decorators.
    • Added custom exceptions, including several for the atomic subpackage.
    • Added import helper and test helper functionality.
  • Created basic framework for diagnostics subpackage.
  • Created a repository for PlasmaPy Enhancement Proposals.
  • Included astropy-helpers as a submodule.

Changes to API

  • PlasmaPy now has an API.

Bug Fixes

  • Fixed bug in universe that cause solar neutrinos to oscillate between different flavors.