Metadata-Version: 2.1
Name: pyechelle
Version: 0.1.6
Summary: A fast generic spectrum simulator
Home-page: https://gitlab.com/Stuermer/pyechelle
License: MIT
Author: Julian Stuermer
Author-email: julian@stuermer.science
Requires-Python: >=3.8,<3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Provides-Extra: optional_dep
Requires-Dist: Autologging (>=1.3.2,<2.0.0)
Requires-Dist: astropy (>=5.0,<6.0)
Requires-Dist: astroquery (>=0.4.4,<0.5.0); extra == "optional_dep"
Requires-Dist: h5py (>=3.1.0,<4.0.0)
Requires-Dist: matplotlib (>=3.3.2,<4.0.0)
Requires-Dist: numba (>=0.54.1,<0.55.0)
Requires-Dist: numpy (==1.20.3)
Requires-Dist: pandas (>=1.3.4,<2.0.0)
Requires-Dist: parmap (>=1.5.2,<2.0.0)
Requires-Dist: plotly (>=5.4.0,<6.0.0)
Requires-Dist: scipy (>=1.5.2,<2.0.0)
Requires-Dist: skycalc-ipy (>=0.1.3,<0.2.0); extra == "optional_dep"
Project-URL: Documentation, https://stuermer.gitlab.io/pyechelle/
Project-URL: Repository, https://gitlab.com/Stuermer/pyechelle
Description-Content-Type: text/markdown

# PyEchelle

PyEchelle is a simulation tool, to generate realistic 2D spectra, in particular cross-dispersed echelle spectra.
However, it is not limited to echelle spectrographs, but allows simulating arbitrary spectra for any fiber-fed or slit
spectrograph, where a model file is available. Optical aberrations are treated accurately, the simulated spectra include
photon and read-out noise.

### Example usage

```bash
pyechelle --spectrograph MaroonX --fiber 2-4 --sources Phoenix --phoenix_t_eff 3500 -t 10 --rv 100 -o mdwarf.fit
```

simulates a PHOENIX M-dwarf spectrum with the given stellar parameters, and a RV shift of 100m/s for the MAROON-X
spectrograph.
 
The output is a 2D raw frame (.fits) and will look similar to:

![](https://gitlab.com/Stuermer/pyechelle/-/raw/master/docs/source/_static/plots/mdwarf.jpg "")

Check out the [Documentation](https://stuermer.gitlab.io/pyechelle/usage.html) for more examples.

Pyechelle is the successor of [Echelle++](https://github.com/Stuermer/EchelleSimulator) which has a similar
functionality but was written in C++. This package was rewritten in python for better maintainability, easier package
distribution and for smoother cross-platform development.

# Installation

As simple as

```bash
pip install pyechelle[optional_dep]
```

Here, adding *[optional_dep]* will also install optional dependencies (e.g. astroquery, skycalc-ipy) for supporting all
features such as atmosphere tellurics.

Check out the [Documentation](https://stuermer.gitlab.io/pyechelle/installation.html) for alternative installation instruction.

# Usage

See

```bash
pyechelle -h
```

for all available command line options.

See [Documentation](https://stuermer.gitlab.io/pyechelle/usage.html) for more examples.

# Citation

Please cite this [paper](http://dx.doi.org/10.1088/1538-3873/aaec2e) if you find this work useful in your research.

