Metadata-Version: 2.4
Name: psoplot
Version: 25.5.2
Summary: PSO Plotting Utils
Project-URL: Homepage, https://github.com/astro-pso/psoplot
Project-URL: Bug Tracker, https://github.com/astro-pso/psoplot/issues
Author-email: Alexander Holas <alex.holas@gmx.de>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.8
Requires-Dist: matplotlib>=3.6.0
Requires-Dist: numpy>=1.21.0
Provides-Extra: docs
Requires-Dist: furo; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-copybutton; extra == 'docs'
Description-Content-Type: text/markdown

# pso_plot
PSO Plotting Utils

## Installation
```bash
pip install psoplot
``````
## Usage

If you only want to use a style, you can use the following code:
```python
import matplotlib.pyplot as plt
import psoplot

plt.style.use("psoplot.aanda_publication")

# [Your plotting code here]

```

If you want to use e.g. a convenient wrapper for generating subplots, you can use the following code:
```python
import psoplot.aanda_plot as aplt

fig, (ax1, ax2) = aplt.subplots(2, 1)
```

Which is essentially a wrapper around ``plt.subplots`` with some convenience settings regarding the
size of the figure.

## Available styles
- `psoplot.aanda_publication`: A style for A&A publication
- `psoplot.aas_publication`: A style for AAS publication, e.g. ApJ, ApJL, ApJS

For example plots, see the (https://astro-pso.github.io/psoplot)[examples] page.
