Metadata-Version: 2.3
Name: tuskitoo
Version: 0.1.1
Summary: tuskitoo: Two-dim Spectra Kit Tool
License: AGPL-3.0-only
Keywords: python package
Author: Felipe Avila-Vera
Author-email: felipe.avilav@postgrado.uv.cl
Maintainer: Felipe Avila-Vera
Maintainer-email: felipe.avilav@postgrado.uv.cl
Requires-Python: >=3.9,<3.13
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Software Distribution
Classifier: Typing :: Typed
Provides-Extra: docs
Provides-Extra: docslive
Provides-Extra: test
Provides-Extra: typing
Requires-Dist: astropy (>=6.0)
Requires-Dist: astroquery
Requires-Dist: csaps
Requires-Dist: h5py
Requires-Dist: lmfit
Requires-Dist: matplotlib (>=3.8.2)
Requires-Dist: mypy (>=1.8.0,<2.0.0) ; extra == "typing"
Requires-Dist: myst_nb
Requires-Dist: nbsphinx
Requires-Dist: numpy (==1.26)
Requires-Dist: pandas (>=2.2.0)
Requires-Dist: parallelbar (>=2.4)
Requires-Dist: photutils
Requires-Dist: pytest (>=8.0.0,<9.0.0) ; extra == "test" or extra == "typing"
Requires-Dist: pytest-click (>=1.1.0,<2.0.0) ; extra == "test" or extra == "typing"
Requires-Dist: pytest-cov (>=4.1.0,<5.0.0) ; extra == "test"
Requires-Dist: pytest-explicit (>=1.0.1,<2.0.0) ; extra == "test"
Requires-Dist: pytest-run-subprocess (>=0.10.0,<0.11.0) ; extra == "test"
Requires-Dist: pytest-xdist (>=3.5.0,<4.0.0) ; extra == "test"
Requires-Dist: regions
Requires-Dist: reproject
Requires-Dist: scipy (>=1.11.4)
Requires-Dist: sphinx (>=5.0,<8.3) ; extra == "docs" or extra == "docslive"
Requires-Dist: sphinx-autobuild (>=2021.3.14,<2022.0.0) ; extra == "docs" or extra == "docslive"
Requires-Dist: sphinx-autodoc-typehints (>=1.10) ; extra == "docs" or extra == "docslive"
Requires-Dist: sphinx-inline-tabs (>=2023.4.21,<2024.0.0) ; (python_version == "3.12") and (extra == "docs" or extra == "docslive")
Requires-Dist: sphinx-rtd-theme (>=1.2.0,<2.0) ; extra == "docs" or extra == "docslive"
Requires-Dist: sphinxcontrib-mermaid (>=0.9.2,<0.10.0) ; (python_version == "3.12") and (extra == "docs" or extra == "docslive")
Requires-Dist: sphinxcontrib-spelling (>=7.3.3,<7.4.0) ; extra == "docs" or extra == "docslive"
Project-URL: Bug Tracker, https://github.com/tuskitoo/issues
Project-URL: CI: Github Actions, https://github.com/favila/tuskitoo/actions
Project-URL: Changelog, https://github.com/favila/tuskitoo/blob/master/CHANGELOG.rst
Project-URL: Code of Conduct, https://github.com/favila/tuskitoo/blob/master/CONTRIBUTING.rst
Project-URL: Documentation, https://tuskitoo.readthedocs.io/
Project-URL: Homepage, https://github.com/favila/tuskitoo
Project-URL: Repository, https://github.com/favila/tuskitoo
Project-URL: Source Code, https://github.com/favila/tuskitoo
Description-Content-Type: text/x-rst

.. image:: https://raw.githubusercontent.com/felavila/tuskitoo/main/docs/source/_static/tuskitoo.png
   :alt: tuskitoo Logo
   :align: left
   :width: 400

Tuskitoo: Two-dim Spectra Kit Tool
==================================

Tuskitoo (Two-dim Spectra Kit Tool) is a Python 3 package that integrates a range of tools for advanced two-dimensional spectral analysis. Originally developed for X-shooter data, it is flexible enough to be applied to spectra from other instruments as well. The package streamlines the spectral extraction process and implements PCA-based sky subtraction, providing a comprehensive framework for analyzing complex spectroscopic observations.

Features
========

- **Spectral Extraction:** Tools for accurate extraction of spectra from raw two-dimensional observations.
- **PCA Sky Subtraction:** Uses Principal Component Analysis (PCA) to effectively subtract sky background.
- **Telluric Correction:** Applies telluric correction to 1D or 2D spectra.
- **Visualization:** Provides straightforward visualization of both 1D and 2D spectra.

Installation
============

Install Tuskitoo locally using the following command:

.. code-block:: shell

   pip install -e .

Prerequisites
=============

You need to have Python == 3.10 installed.

References
==========

Tuskitoo is based on methodologies presented in:

**Melo, A. et al. (2021). First black hole mass estimation for the quadruple lensed system WGD2038-4008. Astronomy & Astrophysics, 656, A108.**
Available at: `ADS Abstract <https://ui.adsabs.harvard.edu/abs/2021A%26A...656A.108M/abstract>`_

License
=======

* Free software: GNU Affero General Public License v3.0

