Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
152 lines (102 sloc) 2.4 KB
tocdepth:3

PlasmaPy Documentation

PlasmaPy logo

PlasmaPy is an open source community-developed core Python 3.6+ package for plasma physics currently under development.

Getting Started

.. toctree::
   :maxdepth: 1

   install
   CONTRIBUTING
   CODE_OF_CONDUCT
   about/citation

User Documentation

Theoretical Analysis

.. toctree::
   :maxdepth: 1

   physics/index
   transport/index
   mathematics/index

Experimental Tools

The ~plasmapy.diagnostics package is in the early stages of development.

.. toctree::
   :maxdepth: 1

   diagnostics/index

Data Structures and Simulation

.. toctree::
    :maxdepth: 1

    plasma/index
    species/index

Physical Data

.. toctree::
    :maxdepth: 1

    constants/index
    atomic/index

Utilities

.. toctree::
   :maxdepth: 1

   utils/index

Examples

.. toctree::
    :maxdepth: 1

    auto_examples/index

Development Guide

The :ref:`plasmapy-development-guide` contains information on how to contribute to PlasmaPy, along with guidelines for code, testing, and documentation.

.. toctree::
    :maxdepth: 1
    :hidden:

    development/index

Project Details

.. toctree::
   :maxdepth: 2

   about/index

Index