PlasmaCalcs API

PlasmaCalcs provides a consistent interface for plasma calculations from any inputs.

These API docs are generated directly from the source code, and can also be seen by calling help(obj) on the corresponding objects (e.g., classes or functions) from Python, after importing PlasmaCalcs.

Core functionality, used by all PlasmaCalculator objects:

PlasmaCalcs.plasma_calculator	File Purpose: The main calculator class, for hookups to inherit from.
PlasmaCalcs.quantities	Package Purpose: managing the various formulae for quantities for PlasmaCalculator.
PlasmaCalcs.dimensions	Package Purpose: dimensions affecting plasma quantity results
PlasmaCalcs.units	Package Purpose: handling units

Providing various types of PlasmaCalculators (if implementing another kind of input which is not yet recognized PlasmaCalcs, you will probably consider adding it inside hookups):

PlasmaCalcs.hookups	Package Purpose: PlasmaCalculator for different types of inputs
PlasmaCalcs.addons	Package Purpose: optional add-ons for PlasmaCalculators
PlasmaCalcs.other_calculators	Package Purpose: other PlasmaCalculators.
PlasmaCalcs.mhd	Package Purpose: stuff related to single-fluid MHD.
PlasmaCalcs.multi_run_analysis	Package Purpose: calculations involving values from multiple runs,

The remaining modules provide a variety of tools, settings, and miscellaneous helpful objects:

PlasmaCalcs.tools	Package purpose: misc tools; portable (not specific to PlasmaCalcs).
PlasmaCalcs.plotting	Package purpose: convenient plotting methods & misc plotting tools
PlasmaCalcs.defaults	File Purpose: defaults in PlasmaCalcs
PlasmaCalcs.errors	File Purpose: errors in PlasmaCalcs