Metadata-Version: 2.1
Name: redcross
Version: 0.0.2
Summary: Reduction and cross-correlation of high-resolution spectroscopy for exoplanet atmospheres
Home-page: https://github.com/DGonzalezPicos/redcross
Author: Darío González Picos
Author-email: Darío González Picos <dariogonzalezpicos@gmail.com>
License: BSD 3-Clause License        
        Copyright (c) 2022,  Max Planck Institute for Astronomy
        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: Homepage, https://github.com/DGonzalezPicos/redcross
Project-URL: Bug Tracker, https://github.com/DGonzalezPicos/redcross/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: importlib-metadata (>=2.0) ; python_version < "3.8"
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-automodapi ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-doctestplus ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'
Requires-Dist: codecov ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'

# redcross: Reduction and Cross-correlation of High-Resolution spectroscopy for exoplanet atmospheres

This repository contains a set of utilities to work with high-resolution order-by-order spectra, in particular
- Read and visualise time-series spectroscopy 
- Define a reduction routine (normalise, remove continuum, SysRem, masking, ...)
- Cross-correlation: Compute the CCF function for a given atmospheric template
- Visualise the results in different reference frames and generate Kp-V_sys map

This package is intended to work with any instrument provided a datacube with the following data:
 - Wave vector (for each order)
 - Flux matrix (for each order and each frame)
 - Flux error matrix (optional, same shape as Flux)
 
 The main object `Datacube` can be directly manipulated using attribute functions e.g. datacube.function(), which already applies the changes to the current
 datacube. By passing an `plt.axes()` object it automatically shows the new datacube. 

