PlasmaPy Documentation🌱 — PlasmaPy 2024.10.0.dev+ged839f9 documentation (original) (raw)

PlasmaPy is an open source community-developed Python 3.10+ 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 ourgetting started notebooks and ourexample gallery. We invite you to share ideas and ask questions in our Matrix chat room or during our weekly virtualoffice hours.

PlasmaPy is developed openly on GitHub, where you canrequest 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 tocite or acknowledge PlasmaPy.

First Steps

• Installing
• Getting Started 🦥
• Examples
• Feedback and Communication
• Code of Conduct
• Acknowledging and Citing

Example highlights

Using PlasmaPy Particles Creating Synthetic Charged Particle Radiographs by Particle Tracing Dispersion: A Full Two Fluid Solution Thomson Scattering: Spectral Density Swept Langmuir Analysis: Floating Potential Emission of Thermal Bremsstrahlung by a Maxwellian Plasma

Package features

• Analysis & Diagnostic Toolkits
• Dispersion
• Formulary
• Particles
• Simulation
• Plasma Calculator
• Plasma Objects
• Package Utilities

All the Rest

• Changelog
• Authors and Credits
• Bibliography
• Glossary
• Performance Tips
• PlasmaPy Enhancement Proposals
• PlasmaPy website
• GitHub Repository

Contributing

• Contributor Guide
• Many Ways to Contribute
• Getting Ready to Contribute 🎉
• Code Contribution Workflow
• Coding Guide 👾
• Testing Guide
• Documentation Guide
• Changelog Guide
• Using pre-commit