Metadata-Version: 2.1
Name: specex
Version: 0.7.11
Summary: Extract spectra from fits cubes
Author: Maurizio D'Addona
Author-email: mauritiusdadd@gmail.com
Maintainer: Maurizio D'Addona
Maintainer-email: mauritiusdadd@gmail.com
License: BSD 3-Clause License
        
        Copyright (c) 2022-2023, Maurizio D'Addona <mauritiusdadd@gmail.com>
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: documentation, https://python-specex.readthedocs.io/en/latest
Project-URL: repository, https://github.com/mauritiusdadd/python-specex
Keywords: spectroscopy,spectra,spectrum,spectral cubes
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: astropy
Requires-Dist: matplotlib
Provides-Extra: animations
Requires-Dist: imageio; extra == "animations"
Provides-Extra: regions
Requires-Dist: regions; extra == "regions"
Provides-Extra: advanced
Requires-Dist: reproject; extra == "advanced"
Provides-Extra: redrock
Requires-Dist: numba; extra == "redrock"
Requires-Dist: sqlalchemy; extra == "redrock"
Requires-Dist: healpy; extra == "redrock"
Requires-Dist: requests; extra == "redrock"
Requires-Dist: fitsio; extra == "redrock"
Requires-Dist: photutils; extra == "redrock"
Requires-Dist: h5py; extra == "redrock"
Provides-Extra: all
Requires-Dist: specex[advanced,animations,redrock,regions]; extra == "all"
Provides-Extra: test
Requires-Dist: coverage; extra == "test"

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7808292.svg)](https://doi.org/10.5281/zenodo.7808292) [![Documentation Status](https://readthedocs.org/projects/python-specex/badge/?version=latest)](https://python-specex.readthedocs.io/en/latest/?badge=latest) [![Build Status](https://github.com/mauritiusdadd/python-specex/actions/workflows/build-and-check.yml/badge.svg)](https://github.com/mauritiusdadd/python-specex/actions/workflows/build-and-check.yml) [![Coverage Status](https://coveralls.io/repos/github/mauritiusdadd/python-specex/badge.svg?branch=main)](https://coveralls.io/github/mauritiusdadd/python-specex?branch=main)
# python-specex

Extract spectra from fits cubes

# SETUP

To install the latest stable version of specex, just use pip:

    $ pip install specex

Some functionalities are enabled only if some optional packages are installed, these packages can be installed by pip when installing Specex by specifing the desired configuration, for example

    $ pip install specex[animation]

will install the packages required to use the command specex-cube-anim, while with the command

    $ pip install specex[animation,regions,redrock]

also the packages to use rrspecex and to enable region file handling will be installed. To install all the optional dependencies use

    $ pip install specex[all]

To install the bleeding edge version, clone the github repository then use pip:

    $ git clone 'https://github.com/mauritiusdadd/python-specex.git'
    $ cd python-specex
    $ pip install .

If you want to use the rrspecex script and the correspondig module, make sure to install also redrock. If you don't already have a system wide installation of redrock, a simple script is provided that creates a python venv and downloads and installs the required packages, in this case the commands to install specex are the following:

    $ chmod +x redrock_venv_setup.sh
    $ ./redrock_venv_setup.sh
    $ . ./redrock_venv/bin/activate
    $ pip install .[redrock]

# DOCUMENTATION

To build the documentation, install the requirements and run sphinx:

    $ pip install -r docs/requirements.txt
    $ sphinx-build -b html docs/ docs/_build/html

The full documentation is also available here: [https://python-specex.readthedocs.io/en/latest/index.html]

# ACKNOWLEDGMENTS

If you used this software for your research, please consider to cite the following article

https://doi.org/10.1051/0004-6361/202349060

```
@ARTICLE{DAddona2024,
  title     = "The powerful lens galaxy cluster {PLCK} G287.0+32.9
               ({$\vartheta$E} $\sim 43$ ′′)",
  author    = "D'Addona, M and Mercurio, A and Rosati, P and Grillo, C and
               Caminha, G and Acebron, A and Angora, G and Bergamini, P and
               Bozza, V and Granata, G and Annunziatella, M and Gargiulo, A and
               Gobat, R and Tozzi, P and Girardi, M and Lombardi, M and
               Meneghetti, M and Schipani, P and Tortorelli, L and Vanzella, E",
  journal   = "Astron. Astrophys.",
  publisher = "EDP Sciences",
  month     =  feb,
  year      =  2024,
}
```
