Logo
stable
  • modules
  • |
  • index

First Steps

  • Vision Statement
  • Installing
  • Examples
  • Feedback and Communication
  • How to Contribute
  • Community Code of Conduct
  • Acknowledging and Citing

Package features

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

Guide for Contributors

  • Overview
    • How to Contribute
    • Community Code of Conduct
    • Installing PlasmaPy for Development
    • Code Development Guidelines
    • Testing Guidelines
    • Documentation Guidelines
    • Release Guide
  • Code Development Guidelines
  • Documentation Guidelines
  • Testing Guidelines

All the Rest

  • Authors and Credits
  • Change Log
  • Stability of Subpackages
  • PlasmaPy.org
PlasmaPy
  • Docs »
  • Development Guide

Development GuideΒΆ

  • How to Contribute
    • Impostor syndrome disclaimer
    • Contributing code or documentation to PlasmaPy
    • Towncrier changelog entries
      • Footnotes
  • Community Code of Conduct
    • Our Pledge
    • Our Standards
    • Our Responsibilities
    • Scope
    • Enforcement
    • Attribution
  • Installing PlasmaPy for Development
    • Obtaining PlasmaPy source code
    • Setting up an environment for development
      • Conda
      • Virtualenv
    • Installing your own dev version
  • Code Development Guidelines
    • Coding Style
      • TL;DR: use pre-commit
      • PlasmaPy Code Style Guide, codified
    • Branches, commits, and pull requests
      • Commit Messages
    • Documentation
    • Warnings and Exceptions
    • Units
    • Equations and Physical Formulae
    • Angular Frequencies
    • Examples
    • Benchmarks
  • Testing Guidelines
    • Motivation
    • Overview
    • Running Tests
      • Running tests on GitHub
      • Running tests from the command line
      • Running tests within Python
    • Writing Tests
      • Best practices for writing tests
      • Test organization and collection
      • Assert statements
      • Floating point comparisons
      • Testing warnings and exceptions
      • Test independence and parametrization
      • Pytest helpers
      • Fixtures
    • Code Coverage
      • Test coverage of contributed code
      • Generating coverage reports locally
      • Ignoring lines in coverage tests
    • Footnotes
  • Documentation Guidelines
    • Building documentation
      • Using sphinx within the project
    • Docstrings
    • Narrative Documentation
  • Release Guide
    • Release
    • Post-release
      • Compatibility with Prior Versions of Python, NumPy, and Astropy
Next Previous

© Copyright 2015-2021, PlasmaPy Community Revision 39f17231.

Built with Sphinx using a theme provided by Read the Docs.

Edit on GitHub | Back to Top

Read the Docs v: stable
Versions
latest
stable
v0.6.x
v0.5.x
v0.4.x
v0.3.x
v0.2.x
v0.1
Downloads
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.