Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 1 KB

index.rst

File metadata and controls

32 lines (24 loc) · 1 KB
Raw

Core package utilities (plasmapy.utils)

plasmapy.utils

Introduction

PlasmaPy.utils is where we store functionality that helps us write (what we try to think of as) clean, readable and informative code. This means:

  • the many kinds of warnings and exceptions you may (hopefully not!) encounter while working with PlasmaPy, such as plasmapy.utils.RelativityWarning or plasmapy.utils.PhysicsError.
  • decorators we use for reusable physical quantity computation and checking, such as plasmapy.utils.decorators.validate_quantities and plasmapy.utils.check_relativistic.
  • Some helper utilities for importing and testing packages such as plasmapy.utils.call_string.

Reference/API

plasmapy.utils.decorators

plasmapy.utils.exceptions

plasmapy.utils.pytest_helpers