| tocdepth: | 3 |
|---|
|PlasmaPy| is an open source community-developed |Python| |minpython|+ package for plasma research and education. PlasmaPy is a platform by which the plasma community can share code and collaboratively develop new software tools for plasma research.
If you are new to PlasmaPy, please check out our :ref:`getting started notebooks <getting-started-notebooks>` and our :ref:`example gallery <examples>`. We invite you to share ideas and ask questions in our |Matrix chat room| or during our weekly virtual |office hours|.
PlasmaPy is developed openly on GitHub, where you can request a new feature or report a bug.
Important
If you use PlasmaPy for work presented in a publication or talk, please help the project by following these instructions to :ref:`cite or acknowledge <citation>` PlasmaPy.
.. toctree:: :caption: First Steps :maxdepth: 1 Installing <install> getting_started examples COMMUNICATION Code of Conduct <CODE_OF_CONDUCT.rst> about/citation
.. nbgallery:: :hidden: notebooks/getting_started/particles notebooks/diagnostics/charged_particle_radiography_particle_tracing notebooks/dispersion/two_fluid_dispersion notebooks/diagnostics/thomson notebooks/analysis/swept_langmuir/find_floating_potential notebooks/formulary/thermal_bremsstrahlung
.. toctree:: :maxdepth: 1 :caption: Package features ad/index Dispersion <dispersion/index> Formulary <formulary/index> Particles <particles/index> Simulation <simulation/index> Plasma Calculator <plasma_calculator/index> Plasma Objects <plasma/index> Package Utilities <utils/index>
.. toctree:: :maxdepth: 1 :caption: All the Rest changelog/index about/credits bibliography glossary performance_tips PlasmaPy Enhancement Proposals <https://github.com/PlasmaPy/PlasmaPy-PLEPs> PlasmaPy website <https://www.plasmapy.org> GitHub Repository <https://github.com/PlasmaPy/PlasmaPy>
.. toctree:: :maxdepth: 1 :caption: Contributor Guide Overview <contributing/index> contributing/getting_ready contributing/workflow contributing/coding_guide contributing/pre-commit contributing/changelog_guide contributing/doc_guide contributing/testing_guide contributing/release_guide