Metadata-Version: 2.1
Name: simpunch
Version: 0.0.2
Summary: Simulate PUNCH observations
Author-email: "J. Marcus Hughes" <hughes.jmb@gmail.com>, Chris Lowder <chris.lowder@swri.org>
Maintainer-email: "J. Marcus Hughes" <hughes.jmb@gmail.com>
Project-URL: Documentation, https://punch-mission.github.io/simpunch/
Project-URL: Repository, https://github.com/punch-mission/simpunch.git
Project-URL: Bug Tracker, https://github.com/punch-mission/simpunch/issues
Project-URL: Changelog, https://github.com/punch-mission/simpunch/blob/main/CHANGELOG.md
Keywords: PUNCH,NASA,simulate,data,solar physics
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: astropy
Requires-Dist: pandas
Requires-Dist: matplotlib
Requires-Dist: regularizepsf
Requires-Dist: prefect[dask,sqlalchemy]
Requires-Dist: punchbowl
Requires-Dist: toml
Requires-Dist: scipy
Requires-Dist: photutils
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-doctestplus; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: ruff; extra == "test"
Requires-Dist: coverage; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-autoapi; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx-favicon; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Requires-Dist: packaging; extra == "docs"

# simpunch

This software creates simulated PUNCH-like data. It's useful in testing the calibration pipeline.

> [!CAUTION]
> This package is still being developed. There will be breaking code changes until v1.
> We advise you to wait until then to use it.

![example simulated image](example.png)

It accepts a total brightness and polarized brightness model as input.
These have been created using the
[FORWARD code](https://www.frontiersin.org/journals/astronomy-and-space-sciences/articles/10.3389/fspas.2016.00008/full)
from [GAMERA simulation data ](https://arxiv.org/pdf/2405.13069).
These images are fed backward through the pipeline from level 3 to level 0 products,
adding appropriate effects along the way.

## Instructions

1. Install the package with `pip install .`
2. Start prefect with `prefect server start`
3. Create a configuration file like [example_config.toml](example_config.toml)
4. Run with `simpunch generate my_config.toml`
