# plasma-plots

> plasma-plots is the plotting and diagnostics package for the output of Struphy, a Python code for plasma physics simulations. It works on labeled xarray data.

How to use it:

- It adds accessors rather than functions to call: `out.plot` and `out.analysis` on a Struphy `Output`, `.plasma.plot`, `.plasma.analysis` and `.plasma.data` on every `xarray.DataArray` product (e.g. `out.evaluate("em_fields/phi")`), and the same on marker Datasets such as orbits.
- Creating a Struphy `Output` loads it, so Struphy output needs no import. For xarray data from elsewhere, run `import plasma_plots` first, or `.plasma` raises an AttributeError.
- Select every dimension a plot does not draw by keyword: an integer is a position (`t=-1` the last), a float the nearest coordinate value.
- In Python, `import plasma_plots; help(plasma_plots)` (or `python -m plasma_plots`) gives an overview, printing an accessor (e.g. `print(phi.plasma.plot)`) lists its methods, and `help()` on a method shows every parameter.
- `plasma_plots.theory` has analytic results to compare runs with: kinetic, fluid, MHD and cold-plasma dispersion relations and growth rates (complex ω), plasma parameters and Struphy units, orbits, exact solutions, and the errors of the numerical schemes. Plain numpy; its functions work directly as `branches=`, `reference=` and `theory=` of the plots.
- Start with the API index (/llms-api.txt, the same as `python -m plasma_plots api`): the conventions every method shares, then every accessor method and function with its signature and one-line summary, in about 40 kB.
- The Reference pages list every accessor method and function with all parameters (also as plain text at /api/plasma_plots/llms.txt); the Guides show them with figures.

## Documentation Sets

- [Abridged documentation](https://max-models.github.io/plasma-plots/llms-small.txt): a compact version of the documentation for plasma-plots, with non-essential content removed
- [Complete documentation](https://max-models.github.io/plasma-plots/llms-full.txt): the full documentation for plasma-plots

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [API index](https://max-models.github.io/plasma-plots/llms-api.txt): the conventions, then every accessor method and function with its signature and summary, one line each (about 40 kB)
- [API reference](https://max-models.github.io/plasma-plots/api/plasma_plots/llms.txt): every module, class and function of plasma_plots with all parameters, as plain text