index.rst

Core package utilities (plasmapy.utils)

plasmapy.utils

Introduction

The ~plasmapy.utils subpackage contains functionality that is needed across multiple subpackages or does not fit nicely in any other subpackage. Functionality contained in ~plasmapy.utils includes:

• Warnings and exceptions used in PlasmaPy, such as ~plasmapy.utils.exceptions.RelativityWarning or ~plasmapy.utils.exceptions.PhysicsError.
• Decorators we use for reusable physical ~astropy.units.Quantity computation and checking, such as ~plasmapy.utils.decorators.validators.validate_quantities and ~plasmapy.utils.decorators.checks.check_relativistic.
• Helper utilities for importing and testing packages.
• Functionality for downloading files from PlasmaPy's data repository.

API

plasmapy.utils.decorators

plasmapy.utils.exceptions

plasmapy.utils.code_repr

plasmapy.utils.pytest_helpers

plasmapy.utils.calculator

plasmapy.utils.data