plasmapy 2026.2.0
Python package for plasma science
Requires Python: >=3.12
Keywords: astronomy, fusion, heliophysics, plasma, plasma physics, science, solar physics, space plasmas

<div align="center"><img src="https://raw.githubusercontent.com/PlasmaPy/PlasmaPy-logo/main/exports/with-text-dark.png" width="600"/></div>

# PlasmaPy

[![PyPI version](https://img.shields.io/pypi/v/plasmapy?style=flat&logo=pypi)](https://pypi.org/project/plasmapy/)
[![Conda version](https://img.shields.io/conda/v/conda-forge/plasmapy?style=flat&logo=anaconda)](https://img.shields.io/conda/v/conda-forge/plasmapy)
[![PyPI version](https://img.shields.io/pypi/pyversions/plasmapy?style=flat&logo=python)](https://img.shields.io/pypi/pyversions/plasmapy?style=plastic)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](./LICENSE.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://docs.plasmapy.org/en/latest/CODE_OF_CONDUCT.html)

[![Matrix](https://img.shields.io/badge/Matrix-join%20chat-blueviolet?style=flat&logo=matrix)](https://app.element.io/#/room/#plasmapy:openastronomy.org)
<a rel="me" href="https://fosstodon.org/@plasmapy">![Mastodon](https://img.shields.io/badge/Mastodon-plasmapy%40fosstodon.org-blue?logo=mastodon&style=fla)</a>
[![YouTube](https://img.shields.io/badge/YouTube%20-subscribe-red?style=flat&logo=youtube)](https://www.youtube.com/channel/UCSH6qzslhqIZKTAJmHPxIxw)

[![CI](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/ci.yml/badge.svg)](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/ci.yml)
[![comprehensive tests](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/ci-comprehensive.yml/badge.svg)](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/ci-comprehensive.yml)
[![upstream tests](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/upstream-tests.yml/badge.svg)](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/upstream-tests.yml)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/PlasmaPy/PlasmaPy/main.svg)](https://results.pre-commit.ci/latest/github/PlasmaPy/PlasmaPy/main)
[![codecov](https://codecov.io/gh/PlasmaPy/PlasmaPy/branch/main/graph/badge.svg)](https://codecov.io/gh/PlasmaPy/PlasmaPy)
[![Read the Docs Status](https://readthedocs.org/projects/plasmapy/badge/?version=latest)](http://plasmapy.readthedocs.io/en/latest/?badge=latest)
[![upstream docs](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/upstream-docs.yml/badge.svg)](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/upstream-docs.yml)

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1436011.svg)](https://doi.org/10.5281/zenodo.1436011)
[![astropy](http://img.shields.io/badge/powered%20by-Astropy-orange.svg?style=flat&logo=astropy)](http://www.astropy.org/)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/)

[PlasmaPy] is an open source, community-developed [Python] package for
plasma research and education. PlasmaPy intends to be for plasma science
what [Astropy] is for astronomy — a collection of functionality commonly
needed by plasma scientists and researchers globally, running within and
leveraging the open source scientific Python ecosystem. The goals of
PlasmaPy are more thoroughly described in [this video]. Many of our
recent presentations are available from the
[PlasmaPy Community on Zenodo].

## Documentation

Please check out our online [**documentation**] to learn more about
PlasmaPy's capabilities.

If you would like an idea of what PlasmaPy can do, go to our
[example gallery] of Jupyter notebooks. To learn more about how to
contribute, check out PlasmaPy's [contributor guide].

## Installing PlasmaPy

PlasmaPy's online documentation has detailed instructions on how to
[**install PlasmaPy**].

To install PlasmaPy on macOS or Linux, open a terminal and run:

```Shell
python -m pip install plasmapy
```

On some systems, it might be necessary to specify the Python version
number, for example by using `python3` or `python3.14` instead of
`python`.

To install PlasmaPy in Windows via PowerShell, run:

```Shell
py -3.14 -m pip install plasmapy
```

The `3.14` may be replaced by any version of Python that is installed
and supported by PlasmaPy.

## Citing PlasmaPy

If you use PlasmaPy for research resulting in a publication, please
[cite PlasmaPy]. It really helps support the project! Citing software
used in research provides credit to its authors, promotes open science &
scientific reproducibility, and helps open source projects demonstrate
to funding agencies that continued development should be supported.

Please check out the [PlasmaPy community on Zenodo] for prior releases
of PlasmaPy and other resources.

## Requesting features

Please [submit a feature request] in our [GitHub repository] if you have
an idea for new or improved functionality. PlasmaPy is community-driven,
and feature requests really help guide the future of the project.

## Submitting bug reports

Please [submit a bug report] on PlasmaPy's GitHub repository if you
notice any problems. We really appreciate it!

## Contributing

If you are interested in contributing, please check out our
[contributor guide] and [code of conduct]. There are a number of
[good first issues] in our GitHub repository. New contributors are very
welcome!

## Events

PlasmaPy has several [meetings] that are on our [calendar]. Events are
usually held on PlasmaPy's [Zoom] room. The most up-to-date information
about these meetings is on the [meetings] page of PlasmaPy's website.

### Community meetings

PlasmaPy's [community meetings] are a place to talk about code
development, event planning, and other community happenings. If you
have an idea for a new feature or would like to become involved in the
PlasmaPy project, community meetings are a great place to start.

## Community

## Contact information

Please feel free to reach out to us at [team@plasmapy.org] or stop by
one of our [community meetings] with any ideas, questions, and/or puns
about computational magnetohydrodynamics.

Please use these links to [submit a feature request],
[submit a bug report], or [privately report a security vulnerability]
on PlasmaPy's GitHub repository.

### GitHub discussions

We're trying out [GitHub discussions] as a place to suggest ideas, bring
up discussion topics, and ask questions.

### Matrix chat

If you have any questions, the quickest way to get a response is to ask
on our [Matrix]/[Gitter] channel. Both of these are the same chat
channel; Gitter uses a bridge to link the two.

### Mailing list

Subscribe to PlasmaPy's low-volume [mailing list] to receive occasional
newsletters and announcements.

## License

PlasmaPy is permissively licensed under a [3-clause BSD license] with
added [protections against software patents].

## Acknowledgments

Development of PlasmaPy has been supported in part by the
[National Science Foundation], [NASA], [Department of Energy], and the
[Smithsonian Institution]. For more details, please see PlasmaPy's
documentation page on [authors and credits].

[**documentation**]: https://docs.plasmapy.org
[**install plasmapy**]: https://docs.plasmapy.org/en/stable/install.html
[3-clause bsd license]: ./LICENSE.md
[astropy]: https://www.astropy.org
[authors and credits]: https://docs.plasmapy.org/en/latest/about/credits.html
[calendar]: https://calendar.google.com/calendar/embed?src=c_sqqq390s24jjfjp3q86pv41pi8%40group.calendar.google.com&ctz=America%2FNew_York
[cite plasmapy]: https://docs.plasmapy.org/en/latest/about/citation.html
[code of conduct]: http://docs.plasmapy.org/en/latest/CODE_OF_CONDUCT.html
[community meetings]: https://www.plasmapy.org/meetings/weekly
[contributor guide]: https://docs.plasmapy.org/en/latest/development/index.html
[department of energy]: https://www.energy.gov
[example gallery]: https://docs.plasmapy.org/en/stable/examples.html
[github discussions]: https://github.com/PlasmaPy/PlasmaPy/discussions
[github repository]: https://github.com/PlasmaPy/PlasmaPy
[gitter]: https://gitter.im/PlasmaPy/Lobby
[good first issues]: https://github.com/PlasmaPy/PlasmaPy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[mailing list]: https://groups.google.com/forum/#!forum/plasmapy
[matrix]: https://app.element.io/#/room/#plasmapy:openastronomy.org
[meetings]: https://www.plasmapy.org/meetings/weekly
[nasa]: https://www.nasa.gov/
[national science foundation]: https://nsf.gov
[plasmapy]: https://www.plasmapy.org
[plasmapy community on zenodo]: https://zenodo.org/communities/plasmapy
[privately report a security vulnerability]: https://github.com/plasmapy/plasmapy/security/advisories/new
[protections against software patents]: ./PATENT.md
[python]: https://www.python.org
[smithsonian institution]: https://www.si.edu
[submit a bug report]: https://github.com/PlasmaPy/PlasmaPy/issues/new?assignees=&labels=Bug&template=bug_report.yml
[submit a feature request]: https://github.com/PlasmaPy/PlasmaPy/issues/new?assignees=&labels=Feature+request&template=feature_request.yml
[team@plasmapy.org]: mailto:team@plasmapy.org
[this video]: https://youtu.be/E8RwQF5wcXM
[zoom]: https://zoom.us/j/91633383503?pwd=QWNkdHpWeFhrYW1vQy91ODNTVG5Ndz09