# overlappogram
[](https://github.com/eccco-mission/overlappogram/actions/workflows/CI.yml)
[](https://codecov.io/gh/eccco-mission/overlappogram)
[](https://zenodo.org/doi/10.5281/zenodo.10869534)
Overlappogram is a Python package for inverting overlappogram observations of the Sun,
for examples MaGIXS, CubIXSS, or ECCCO observations.
For background on the theory of this technique, see [this paper](https://arxiv.org/abs/2407.10436v1).
## Install
`pip install overlappogram` or clone the repository and install manually.
## How to Use
`overlappogram` comes with an executable main that you can run:
`unfold ./path/to/config.toml`
The `config.toml` file should be structured similar to the [example_config.toml](example_config.toml).
We provide more description of the config file [in the documentation](https://eccco-mission.github.io/overlappogram/configuration.html).
## Getting Help
Please [open an issue](https://github.com/ECCCO-mission/overlappogram/issues/new/choose)
or [create a discussion](https://github.com/eccco-mission/overlappogram/discussions/new/choose).
We prefer this over email so that other users can benefit from your questions.
## Cite
[Please cite using the Zenodo DOI.](https://zenodo.org/records/10869577)
## Contributors
The initial version of `overlappogram` was written by Dyana Beabout.
This version is written by [J. Marcus Hughes](https://github.com/jmbhughes).
Raw data
{
"_id": null,
"home_page": null,
"name": "overlappogram",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "\"J. Marcus Hughes\" <hughes.jmb@gmail.com>",
"keywords": "overlappogram, solar, physics, analysis",
"author": null,
"author_email": "\"J. Marcus Hughes\" <hughes.jmb@gmail.com>, Dyana Beabout <dyana.l.beabout@nasa.gov>",
"download_url": "https://files.pythonhosted.org/packages/33/d0/4cb3c8abfb737d6409234c31e61e12478b6442f89c4cb6bda72dd7f3495a/overlappogram-0.0.10.tar.gz",
"platform": null,
"description": "# overlappogram\n\n[](https://github.com/eccco-mission/overlappogram/actions/workflows/CI.yml)\n[](https://codecov.io/gh/eccco-mission/overlappogram)\n[](https://zenodo.org/doi/10.5281/zenodo.10869534)\n\n\n\nOverlappogram is a Python package for inverting overlappogram observations of the Sun,\nfor examples MaGIXS, CubIXSS, or ECCCO observations.\n\nFor background on the theory of this technique, see [this paper](https://arxiv.org/abs/2407.10436v1).\n\n\n## Install\n\n`pip install overlappogram` or clone the repository and install manually.\n\n## How to Use\n\n`overlappogram` comes with an executable main that you can run:\n\n`unfold ./path/to/config.toml`\n\nThe `config.toml` file should be structured similar to the [example_config.toml](example_config.toml).\nWe provide more description of the config file [in the documentation](https://eccco-mission.github.io/overlappogram/configuration.html).\n\n## Getting Help\n\nPlease [open an issue](https://github.com/ECCCO-mission/overlappogram/issues/new/choose)\nor [create a discussion](https://github.com/eccco-mission/overlappogram/discussions/new/choose).\nWe prefer this over email so that other users can benefit from your questions.\n\n## Cite\n\n[Please cite using the Zenodo DOI.](https://zenodo.org/records/10869577)\n\n## Contributors\n\nThe initial version of `overlappogram` was written by Dyana Beabout.\nThis version is written by [J. Marcus Hughes](https://github.com/jmbhughes).\n",
"bugtrack_url": null,
"license": "## Public Domain This project constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC \u00a7 105. Additionally, we waive copyright and related rights in the work worldwide through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/). Contributions to this project will be released under the CC0 dedication unless otherwise indicated. Material that is not under public domain or available under a CC0 license is marked with the license for that material. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest. Any material that cannot be shared as CC0 should be noted in the pull request along with the license of that material. ## Other Information In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights. Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer. ",
"summary": "Overlappogram unfolding and analysis software",
"version": "0.0.10",
"project_urls": {
"Bug Tracker": "https://github.com/eccco-mission/overlappogram/issues",
"Changelog": "https://github.com/eccco-mission/overlappogram/blob/main/CHANGELOG.md",
"Documentation": "https://eccco-mission.github.io/overlappogram/",
"Homepage": "https://github.com/ECCCO-mission/overlappogram",
"Repository": "https://github.com/eccco-mission/overlappogram.git"
},
"split_keywords": [
"overlappogram",
" solar",
" physics",
" analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33d04cb3c8abfb737d6409234c31e61e12478b6442f89c4cb6bda72dd7f3495a",
"md5": "49bfb9617609c6007afa27b5582b9096",
"sha256": "dc2748c6df1fcd3aa7326a264213a6c18dca8bc034b042f6e2b3054dd70a5e10"
},
"downloads": -1,
"filename": "overlappogram-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "49bfb9617609c6007afa27b5582b9096",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 14019,
"upload_time": "2024-07-25T20:48:41",
"upload_time_iso_8601": "2024-07-25T20:48:41.778057Z",
"url": "https://files.pythonhosted.org/packages/33/d0/4cb3c8abfb737d6409234c31e61e12478b6442f89c4cb6bda72dd7f3495a/overlappogram-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-25 20:48:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eccco-mission",
"github_project": "overlappogram",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "overlappogram"
}
