Metadata-Version: 2.3
Name: lezargus
Version: 0.0.4.dev42
Summary: The accompanying data software package to the IRTF SPECTRE Spectrograph.
Project-URL: Homepage, http://irtfweb.ifa.hawaii.edu/~spectre/
Project-URL: Documentation, https://psmd-iberutaru.github.io/Lezargus/
Project-URL: Issues, https://github.com/psmd-iberutaru/Lezargus/issues
Project-URL: Source, https://github.com/psmd-iberutaru/Lezargus/
Author-email: Sparrow <psmd.iberutaru@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: astropy
Requires-Dist: colorama==0.4.6
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pyside6>=6.5.0
Requires-Dist: pyyaml
Requires-Dist: scipy
Description-Content-Type: text/markdown

# Lezargus

[![GitHub Pages Status](https://img.shields.io/github/actions/workflow/status/psmd-iberutaru/Lezargus/pages%2Fpages-build-deployment?branch=master&logo=github&label=Github%20Pages)](https://psmd-iberutaru.github.io/Lezargus/)
[![CodeQL Status](https://img.shields.io/github/actions/workflow/status/psmd-iberutaru/Lezargus/github-code-scanning%2Fcodeql?branch=master&logo=github&label=CodeQL)](https://github.com/psmd-iberutaru/Lezargus/actions/workflows/github-code-scanning/codeql)
[![Formatting Status](https://img.shields.io/github/actions/workflow/status/psmd-iberutaru/Lezargus/format.yaml?branch=master&label=Formatting)](https://github.com/psmd-iberutaru/Lezargus/actions/workflows/format.yaml)
[![Linting Status](https://img.shields.io/github/actions/workflow/status/psmd-iberutaru/Lezargus/lint.yaml?branch=master&label=Linting)](https://github.com/psmd-iberutaru/Lezargus/actions/workflows/lint.yaml)
[![Test Status](https://img.shields.io/github/actions/workflow/status/psmd-iberutaru/Lezargus/tests.yaml?branch=master&label=Tests)](https://github.com/psmd-iberutaru/Lezargus/actions/workflows/tests.yaml)
[![PyPI](https://img.shields.io/pypi/v/Lezargus)](https://pypi.org/project/Lezargus/)
[![GitHub](https://img.shields.io/github/license/psmd-iberutaru/Lezargus)](https://github.com/psmd-iberutaru/Lezargus/blob/master/LICENSE.txt)

The Lezargus project is the accompanying data software simulation and 
reduction package for the IRTF SPECTRE Spectrograph.


## Documentation

We aim to have extensive documentation through our generated files and 
publications. 

The canonical publications for Lezargus are as follows. If you use Lezargus in 
any of your work, please cite accordingly. 

- [[Simulation Paper]]
- [[Reduction Paper]]

Primary documentation for the Lezargus package can be found via our generated
documentation manuals. If you are reducing SPECTRE data, see the User Manual.

- <https://psmd-iberutaru.github.io/Lezargus>

Secondary (internal) publications also serve as additional documentation of 
Lezargus. These publications usually contain more detail than canonical 
publications, way too often to an expatiated degree.

- [[Simulation White Paper]]


## Issues and Contributing

Contributions are very much welcome!

- Found a bug or issue? [Create a GitHub Issue](https://github.com/psmd-iberutaru/Lezargus/issues)
- Want a feature? [Create a GitHub Issue](https://github.com/psmd-iberutaru/Lezargus/issues)
- Submitting a patch? [Create a GitHub Pull Request](https://github.com/psmd-iberutaru/Lezargus/pulls)

[Please see our contributing guidelines.](https://github.com/psmd-iberutaru/Lezargus/blob/master/CONTRIBUTING.md)

If you found a security issue, please see our 
[Security Policy](https://github.com/psmd-iberutaru/Lezargus/blob/master/SECURITY.md) 
for reporting the issue. 

If you have any other questions; you can either 
[Create a GitHub Issue](https://github.com/psmd-iberutaru/Lezargus/issues) 
(suggested) or contact the developers or IRTF staff directly. 