Metadata-Version: 2.4
Name: teareduce
Version: 0.4.6
Summary: Utilities for astronomical data reduction
Author-email: Nicolás Cardiel <cardiel@ucm.es>
License: GPL-3.0-or-later
Project-URL: Homepage, https://github.com/nicocardiel/teareduce
Project-URL: Repository, https://github.com/nicocardiel/teareduce.git
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: astropy
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: numpy>=1.22
Requires-Dist: scipy
Requires-Dist: tqdm
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

# teareduce

Utilities for astronomical data reduction.

This package is not intended to be a general-purpose image reduction code. It
only includes specific operations required in certain steps of the traditional
astronomical image reduction process that, at the time of its creation, were
not available in more established packages such as
[ccdproc](https://ccdproc.readthedocs.io/en/latest/). In addition, it also
offers alternative ways to perform certain tasks that we have found to be more
practical for use in Master’s level classes.


## Documentation

The documentation for this package is available at [this
link](https://guaix.fis.ucm.es/~tea/teareduce-cookbook/_build/html/intro.html).
It includes Juypter notebooks that can be easily downloaded and demonstrate the
practical use of the defined functionality.

## Installing the code

In order to keep your Python installation clean, it is highly recommended to 
first build a specific Python 3 *virtual enviroment*

### Creating and activating the Python virtual environment

```shell
$ python3 -m venv venv_teareduce
$ . venv_teareduce/bin/activate
(venv_teareduce) $ 
```

### Installing the package

The latest stable version is available via de [PyPI repository](https://pypi.org/project/teareduce/):

```shell
(venv_teareduce) $ pip install teareduce
```

**Note**: This command can also be employed in a Windows terminal opened through the 
``CMD.exe prompt`` icon available in Anaconda Navigator.

The latest development version is available through [GitHub](https://github.com/nicocardiel/teareduce):

```shell
(venv_teareduce) $ pip install git+https://github.com/nicocardiel/teareduce.git@main#egg=teareduce
```

### Testing the installation

```shell
(venv_teareduce) $ pip show teareduce
```

```shell
(venv_teareduce) $ ipython
In [1]: import teareduce as tea
In [2]: print(tea.__version__)
0.4.3
```

