# 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`
Raw data
{
"_id": null,
"home_page": null,
"name": "simpunch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "\"J. Marcus Hughes\" <hughes.jmb@gmail.com>",
"keywords": "PUNCH, NASA, simulate, data, solar physics",
"author": null,
"author_email": "\"J. Marcus Hughes\" <hughes.jmb@gmail.com>, Chris Lowder <chris.lowder@swri.org>",
"download_url": "https://files.pythonhosted.org/packages/e0/22/9a7ceda800c9f9fd53428b8d10b2228700acf1da1ef7e2868434432df404/simpunch-0.0.3.tar.gz",
"platform": null,
"description": "# simpunch\n\nThis software creates simulated PUNCH-like data. It's useful in testing the calibration pipeline.\n\n> [!CAUTION]\n> This package is still being developed. There will be breaking code changes until v1.\n> We advise you to wait until then to use it.\n\n![example simulated image](example.png)\n\nIt accepts a total brightness and polarized brightness model as input.\nThese have been created using the\n[FORWARD code](https://www.frontiersin.org/journals/astronomy-and-space-sciences/articles/10.3389/fspas.2016.00008/full)\nfrom [GAMERA simulation data ](https://arxiv.org/pdf/2405.13069).\nThese images are fed backward through the pipeline from level 3 to level 0 products,\nadding appropriate effects along the way.\n\n## Instructions\n\n1. Install the package with `pip install .`\n2. Start prefect with `prefect server start`\n3. Create a configuration file like [example_config.toml](example_config.toml)\n4. Run with `simpunch generate my_config.toml`\n",
"bugtrack_url": null,
"license": null,
"summary": "Simulate PUNCH observations",
"version": "0.0.3",
"project_urls": {
"Bug Tracker": "https://github.com/punch-mission/simpunch/issues",
"Changelog": "https://github.com/punch-mission/simpunch/blob/main/CHANGELOG.md",
"Documentation": "https://punch-mission.github.io/simpunch/",
"Repository": "https://github.com/punch-mission/simpunch.git"
},
"split_keywords": [
"punch",
" nasa",
" simulate",
" data",
" solar physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e0229a7ceda800c9f9fd53428b8d10b2228700acf1da1ef7e2868434432df404",
"md5": "273a4bf52dadd685188f41b70d84c6cd",
"sha256": "11d0a271a5ce45d6dc3295d154bd74d7a20c0c39258842de241581007a2edbe0"
},
"downloads": -1,
"filename": "simpunch-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "273a4bf52dadd685188f41b70d84c6cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3090821,
"upload_time": "2024-12-19T16:11:55",
"upload_time_iso_8601": "2024-12-19T16:11:55.069827Z",
"url": "https://files.pythonhosted.org/packages/e0/22/9a7ceda800c9f9fd53428b8d10b2228700acf1da1ef7e2868434432df404/simpunch-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 16:11:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "punch-mission",
"github_project": "simpunch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "simpunch"
}