Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.71 KB

README.md

File metadata and controls

41 lines (24 loc) · 1.71 KB

overlappogram

CI codecov DOI

overlappogram example

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.

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. We provide more description of the config file in the documentation.

Getting Help

Please open an issue or create a discussion. We prefer this over email so that other users can benefit from your questions.

Cite

Please cite using the Zenodo DOI.

Contributors

The initial version of overlappogram was written by Dyana Beabout. This version is written by J. Marcus Hughes.