https://github.com/eccco-mission/overlappogram

Unfold solar overlappograms.
https://github.com/eccco-mission/overlappogram

nasa physics solar sun

Last synced: 5 months ago
JSON representation

Unfold solar overlappograms.

• Host: GitHub
• URL: https://github.com/eccco-mission/overlappogram
• Owner: ECCCO-mission
• License: other
• Created: 2024-02-18T01:28:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-10-06T16:26:38.000Z (8 months ago)
• Last Synced: 2025-10-13T11:36:34.475Z (8 months ago)
• Topics: nasa, physics, solar, sun
• Language: Python
• Homepage: https://eccco-mission.github.io/overlappogram/
• Size: 27.5 MB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# overlappogram

[![CI](https://github.com/eccco-mission/overlappogram/actions/workflows/CI.yml/badge.svg)](https://github.com/eccco-mission/overlappogram/actions/workflows/CI.yml)

[![codecov](https://codecov.io/gh/eccco-mission/overlappogram/graph/badge.svg?token=u1qQvzybz4)](https://codecov.io/gh/eccco-mission/overlappogram)

[![DOI](https://zenodo.org/badge/759222503.svg)](https://zenodo.org/doi/10.5281/zenodo.10869534)

![overlappogram example](https://raw.githubusercontent.com/ECCCO-mission/overlappogram/main/overlappogram.png)

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).