Metadata-Version: 2.4
Name: hydron
Version: 0.0.6
Summary: Python interface for launching and post-processing SWMF magnetohydrodynamic simulations
Author-email: Sujay Shankar <sujays2001@gmail.com>
License-Expression: MIT
Project-URL: Repository, https://github.com/Sujay-Shankar/hydron
Project-URL: Issues, https://github.com/Sujay-Shankar/hydron/issues
Project-URL: Documentation, https://sujay-shankar.github.io/hydron
Project-URL: Releases, https://github.com/Sujay-Shankar/hydron/releases
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: docs
Requires-Dist: mystmd; extra == "docs"
Dynamic: license-file

# **hydron**
Python interface for launching and post-processing SWMF magnetohydrodynamic simulations

## Installation
All examples assume the use of `uv`.
### Express
For when you're using the package just for analysis.
```bash
uv pip install hydron
```

### Developer
For when you are developing a project of your own and are trying to add `hydron` as a dependency.
```bash
uv add hydron
```

## Contributor Guide
Contributors are expected to be using `uv`.
Please fork `hydron` and submit your changes in a pull request.
The following are some common workflows.

### Testing
```bash
    uv run --extra test pytest
```

### Previewing Documentation
```bash
    uv run --extra docs myst start
```
