Skip to content
An open source Python package for plasma science that is under development
Python
Branch: master
Clone or download

Latest commit

rocco8773 Handle ModuleNotFoundError when importing __version__ from version.py (
…#763)

* catch ModuleNotFoundError when importing __version__ is package is not installed

* add changelog for PR GH-763

* rename changelog entry 763.bugfix.rst -> 763.trivial.rst

* if PlasmaPy is not installed, try to generate __version__ with setuptools_scm. if setuptools_scm is not installed, then warn and set version to 0.0.0
Latest commit 2c2a23a Feb 25, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci MNT: Fix Giles URL Jan 23, 2020
.github Modify GitHub issue and PR templates (#702) Oct 17, 2019
.jupyter Binder integration via jupytext (#656) Jul 1, 2019
binder Binder integration via jupytext (#656) Jul 1, 2019
changelog Handle ModuleNotFoundError when importing __version__ from version.py ( Feb 25, 2020
docs Rename plasmapy.atomic to plasmapy.particles (#742) Feb 4, 2020
licenses Add roman package license Jul 16, 2018
plasmapy Handle ModuleNotFoundError when importing __version__ from version.py ( Feb 25, 2020
requirements Use pip for RTD Feb 1, 2020
.codecov.yaml Set codecov failure threshold to 0.2% (#704) Oct 19, 2019
.coveragerc Remove lingering astropy-helpers references (#671) Sep 5, 2019
.gitignore Release v0.3.0 prep work (#739) Feb 1, 2020
.gitmodules Remove astropy_helpers submodule (#663) Aug 21, 2019
.mailmap Release v0.3.0 prep work (#739) Feb 1, 2020
.pep8speaks.yml Update max-line-length in .pep8speaks.yml Mar 8, 2018
.readthedocs.yml Use pip for RTD Feb 1, 2020
.travis.yml Reenable parallel testing (#664) Jul 22, 2019
.zenodo.json Add file with metadata for Zenodo upload May 30, 2019
CHANGELOG.rst Release v0.3.0 prep work (#739) Feb 1, 2020
CITATION.rst Update funding acknowledgements to reflect NSF CSSI grant (#688) Oct 9, 2019
Dockerfile.documentation Combine CircleCI jobs again (#394) Apr 24, 2018
LICENSE.md Update PlasmaPy copyright for 2019 (#592) Jan 4, 2019
MANIFEST.in Remove lingering astropy-helpers references (#671) Sep 5, 2019
README.md Update communication channels (#715) Nov 2, 2019
azure-pipelines.yml Release v0.3.0 prep work (#739) Feb 1, 2020
codemeta.json Creating a Codemeta JSON file (#676) Sep 12, 2019
pyproject.toml Fix Gilesbot settings (#719) Nov 4, 2019
setup.cfg Release v0.3.0 prep work (#739) Feb 1, 2020
setup.py Reformat most subpackages with black code formatter (#761) Feb 14, 2020
tox.ini Release v0.3.0 prep work (#739) Feb 1, 2020

README.md

PlasmaPy

PyPI version License DOI

Build Status Build Status Build status codecov Documentation Status Binder

Matrix Gitter astropy Open Source Helpers

PlasmaPy is an open source community developed Python 3.6+ package for plasma physics in the early stages of development. PlasmaPy intends to be for plasmas what Astropy is for astronomy - a collection of functionality commonly used and shared between plasma physicists and researchers globally, running within and leveraging the open source scientific Python ecosystem. The goals of this project are more thoroughly described in our vision statement and this recent reference. We are in the process of writing online documentation.

We created a guide on contributing to PlasmaPy and have a Code of Conduct. New contributors are very welcome!

Feedback and communication

Matrix chat

If you have any questions, the quickest way to get a response is to ask on our Matrix/Gitter channel.

Discourse room

We have recently created a PlasmaPy Discourse group in order to allow threaded public discussions on a variety of topics. This group is a great place to suggest ideas, bring up discussion topics, and ask questions.

Mailing list

We also have a mailing list that serves as a less volatile discussion forum.

Suggestion box

We have a suggestion box if you would like to (optionally anonymously) suggest a feature/topic for consideration. These will be reposted on the mailing list or directly in GitHub issues, as appropriate, for further discussion.

Weekly community meetings

We have approximately weekly community meetings in the PlasmaPy room on Jitsi. The schedule of our community meetings is on our calendar, and you may access the minutes and agendas. Any last minute changes will be discussed on Matrix. As of November 2019, our meetings are on Tuesdays at 19:00 UTC. Come discuss plasma software with us!

Installation

You can get PlasmaPy from pip via pip install plasmapy. To contribute to the package, check out our instructions on installing PlasmaPy from source.

You can also get PlasmaPy from conda via conda install -c conda-forge plasmapy.

Like most scientific Python packages, PlasmaPy probably runs better on the Anaconda distribution.

PlasmaPy requires Python 3.6+ and is not compatible with Python 2.

License

PlasmaPy is licensed under a 3-clause BSD license with added protections against software patents - see the LICENSE.md file in the top-level directory.

Citing PlasmaPy

Please see the CITATION.rst file for instructions on how to cite PlasmaPy.

Acknowledgements

Early development on PlasmaPy was supported in part by the U.S. Department of Energy, the Smithsonian Institution, and Google Summer of Code. Ongoing PlasmaPy development is being supported through a collaborative award from the U.S. National Science Foundation's Cyberinfrastructure for Sustained Scientific Innovation program.

You can’t perform that action at this time.