Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jmbhughes authored Mar 25, 2024
1 parent 5173ee6 commit 2834772
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@

[![CI](https://github.com/jmbhughes/overlappogram/actions/workflows/CI.yml/badge.svg)](https://github.com/jmbhughes/overlappogram/actions/workflows/CI.yml)
[![codecov](https://codecov.io/gh/jmbhughes/overlappogram/graph/badge.svg?token=u1qQvzybz4)](https://codecov.io/gh/jmbhughes/overlappogram)
[![DOI](https://zenodo.org/badge/759222503.svg)](https://zenodo.org/doi/10.5281/zenodo.10869534)

![overlappogram example](overlappogram.png)

🚧🚧🚧 **UNDER DEVELOPMENT** 🚧🚧🚧

Overlappogram is a Python package for inverting overlappogram observations of the Sun,
for examples MaGIXS, CubIXSS, or ECCCO observations.

**The package is still being developed. Expect breaking changes.**

# Install

`pip install overlappogram` or clone the repository and install manually
Expand All @@ -22,12 +27,15 @@ The `config.toml` file should be structured similar to the [example_config.toml]


## Getting Help

Please [open an issue](https://github.com/jmbhughes/overlappogram/issues/new)
or [create a discussion](https://github.com/jmbhughes/overlappogram/discussions/new/choose).
We prefer this over email so that other users can benefit from your questions.

## Cite

[Please cite using Zenodo DOI.](https://zenodo.org/records/10869577)

## Contributors

The initial version of `overlappogram` was written by Dyana Beabout.
Expand Down

0 comments on commit 2834772

Please sign in to comment.