stable
modules
|
index
First Steps
Installing
Getting Started
Examples
Feedback and Communication
How to Contribute
Code of Conduct
Acknowledging and Citing
Package features
Analysis & Diagnostic Toolkits
Dispersion
Formulary
Particles
Simulation
Plasma Calculator
Plasma Objects
Package Utilities
Contributor Guide
Overview
How to Contribute
Contributor Covenant Code of Conduct
Installing PlasmaPy for Development
Coding Guide
Changelog Guide
Testing Guide
Documentation Guide
Release Guide
Coding Guide
Changelog Guide
Documentation Guide
Testing Guide
Release Guide
All the Rest
Changelog
Authors and Credits
Bibliography
Glossary
Performance Tips
Vision Statement
PlasmaPy Enhancement Proposals
PlasmaPy.org
GitHub Repository
PlasmaPy
Contributor Guide
Contributor Guide
How to Contribute
Impostor syndrome disclaimer
Contributing code or documentation to PlasmaPy
Towncrier changelog entries
Footnotes
Contributor Covenant Code of Conduct
Our Pledge
Our Standards
Enforcement Responsibilities
Scope
Enforcement
Enforcement Guidelines
1. Correction
2. Warning
3. Temporary Ban
4. Permanent Ban
Attribution
Installing PlasmaPy for Development
Obtaining PlasmaPy source code
Setting up an environment for development
Conda
Virtualenv
Installing pre-commit
Coding Guide
Introduction
Coding guidelines
Names
Comments
Error messages
Project infrastructure
Imports
Requirements
Special function categories
Aliases
Lite Functions
Physics
Units
Particles
Equations and Physical Formulae
Angular Frequencies
Example notebooks
Compatibility with Prior Versions of Python, NumPy, and Astropy
Branches, commits, and pull requests
Benchmarks
Changelog Guide
Introduction
Adding a changelog entry
Changelog guidelines
Building the changelog
Testing Guide
Summary
Introduction
Running tests
Using GitHub
Using pytest
Using tox
Using an integrated development environment
Writing Tests
Locating tests
Assertions
Floating point comparisons
Testing warnings and exceptions
Test independence and parametrization
Fixtures
Property-based testing
Code coverage
Generating coverage reports with pytest
Excluding lines in coverage reports
Coverage configurations
Best practices
Documentation Guide
Introduction
Building documentation
Prerequisites
Building documentation with make
Building documentation with tox
Documentation tools
ReStructuredText
Markdown
Sphinx
Writing documentation
Docstrings
Definitions
Documentation guidelines
Docstring guidelines
Narrative documentation guidelines
Troubleshooting
Reference target not found
Missing documentation pages for new modules
Missing attribute errors
List ends without a blank line
Errors that are unrelated to a pull request
Release Guide
Introduction
Announce the release timeline
Update metadata
Perform code quality checks
Create the release branch
Publish the release
Post-release
Advertise the release
Read the Docs
v: stable
Versions
latest
stable
v2023.1.x
v0.9.x
v0.9.0
v0.8.x
v0.7.x
v0.6.x
v0.5.x
v0.4.x
v0.3.x
v0.2.x
v0.1
proto-swept-langmuir
Downloads
html
On Read the Docs
Project Home
Builds