Metadata-Version: 2.4
Name: slitlessutils
Version: 2.0.0
Summary: A compendium of tools to analyze slitless spectroscopy
Author: Slitlessutils Developers
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/spacetelescope/slitlessutils
Project-URL: Documentation, https://slitlessutils.readthedocs.io/en/stable/
Keywords: grism,prism,slitless spectroscopy,HST,WFC3,UVIS,IR,ACS,WFC,SBC,JWST,NIRISS,wide field
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.rst
Requires-Dist: astropy>=6.1
Requires-Dist: astroquery>=0.4.7
Requires-Dist: h5py>=3.11
Requires-Dist: drizzlepac>=3.9.1
Requires-Dist: networkx>=3.3
Requires-Dist: numba>=0.62.0
Requires-Dist: numpy>=2.0
Requires-Dist: matplotlib>=3.9
Requires-Dist: pandas>=2.2
Requires-Dist: psutil>=5.9.0
Requires-Dist: pypolyclip>=1.0.0
Requires-Dist: pysiaf>=0.16.4
Requires-Dist: scikit-image>=0.23
Requires-Dist: scipy>=1.12
Requires-Dist: shapely>=2.0
Requires-Dist: tqdm>=4.66
Provides-Extra: test
Requires-Dist: pytest-astropy>=0.11; extra == "test"
Requires-Dist: tox>=4.12; extra == "test"
Provides-Extra: docs
Requires-Dist: sphinx-astropy>=1.6; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Dynamic: license-file

# Slitlessutils

[![PyPI Version](https://img.shields.io/pypi/v/slitlessutils.svg)](https://pypi.org/project/slitlessutils/) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10215187.svg)](https://doi.org/10.5281/zenodo.10215187) [![CI Tests](https://github.com/spacetelescope/slitlessutils/actions/workflows/ci_tests.yml/badge.svg?branch=main)](https://github.com/spacetelescope/slitlessutils/actions/workflows/ci_tests.yml) [![Documentation Status](https://readthedocs.org/projects/slitlessutils/badge/?version=latest)](https://slitlessutils.readthedocs.io/en/latest/)

Slitlessutils is a package for simulating and extracting wide-field slitless spectroscopy (WFSS) data, highly focused on data from the Advanced Camera for Surveys (ACS) and Wide-Field Camera 3 (WFC3) on the *Hubble Space Telescope*.


## Early Development Software Warning
Slitlessutils is under active development software and subject to change.


## Quickstart

The latest released version of this package can be installed using pip
from the command line:
```
pip install slitlessutils
```

To install the latest development version of this repository, please use:
```
pip install git+https://github.com/spacetelescope/slitlessutils.git
```

You may run into an error building `llvmlite`, a dependency of `numba` (used to increase performance in `slitlessutils`) during installation.
This can be fixed by running `conda install --channel=numba llvmlite` in your conda environment before installing `slitessutils`.

You also need to obtain the calibration (reference) files, which are stored in a public box folder, which can be done with the slitlessutils config objects.  Please see [configuring slitlessutils](https://slitlessutils.readthedocs.io/en/latest/configure.html)
for instructions and examples.  Please see our [documentation](https://slitlessutils.readthedocs.io/en/latest/install.html)
for additional installation instructions and/or methods.

We have encountered several frequently-asked questions and give some examples our [FAQ page](https://slitlessutils.readthedocs.io/en/latest/faq.html).
