Metadata-Version: 2.1
Name: resspect
Version: 0.1
Author-email: The RESSPECT team <contact@cosmostatistics-initiative.org>
License: MIT License
        
        Copyright (c) 2024 The RESSPECT team
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/COINtoolbox/resspect
Project-URL: Source, https://github.com/COINtoolbox/resspect
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: flask ==2.3.2
Requires-Dist: astropy >=5.2.1
Requires-Dist: matplotlib >=3.7.0
Requires-Dist: numpy >=1.24.2
Requires-Dist: pandas >=1.5.3
Requires-Dist: progressbar2 >=4.2.0
Requires-Dist: pytest >=7.2.1
Requires-Dist: scikit-learn >=1.2.1
Requires-Dist: scipy >=1.10.0
Requires-Dist: seaborn >=0.12.2
Requires-Dist: xgboost >=1.7.3
Requires-Dist: iminuit >=1.20.0
Requires-Dist: light-curve >=0.8.1
Requires-Dist: requests
Requires-Dist: pooch
Provides-Extra: dev
Requires-Dist: asv ==0.6.4 ; extra == 'dev'
Requires-Dist: jupyter ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'

[![resspect](https://img.shields.io/badge/COIN--Focus-RESSPECT-red)](http://cosmostatistics-initiative.org/resspect/)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/LSSTDESC/RESSPECT/smoke-test.yml)](https://github.com/LSSTDESC/RESSPECT/actions/workflows/smoke-test.yml)
[![Benchmarks](https://img.shields.io/github/actions/workflow/status/LSSTDESC/RESSPECT/asv-main.yml?label=benchmarks)](https://LSSTDESC.github.io/RESSPECT/benchmarks)


# <img align="right" src="docs/images/logo_small.png" width="350"> RESSPECT


## Recommendation System for Spectroscopic follow-up 

This repository holds the pipeline of the RESSPECT project, built as part of the inter-collaboration activities developed by the Cosmostatistics Initiative ([COIN](cosmostatistics-initiative.org)) and the LSST Dark Energy Science Collaboration ([DESC](https://lsstdesc.org/)).

This work grew from activities developed within the [COIN Residence Program #4](http://iaacoin.wix.com/crp2017), using as a starting point their [ActSNClass](https://github.com/COINtoolbox/ActSNClass) software. 

The active learning and telescope resources pipeline is described in [Kennamer et al, 2020](https://cosmostatistics-initiative.org/portfolio-item/resspect1/). The pre-processed data set used to obtain the results shown in the paper is available through zenodo at [de Souza et al., 2020](https://zenodo.org/record/4399109#.X-sL21lKhNg).

We kindly ask you to include the full citation for the above mentioned work if you use this material in your research.

Full documentation can be found at [readthedocs](https://resspect.readthedocs.io/en/latest/).

# Dependencies

### For main code:

 - python >= 3.10.10  
 - astropy >= 5.2.1  
 - matplotlib >= 3.7.0
 - numpy >= 1.24.2
 - pandas >= 1.5.3
 - progressbar2 >= 4.2.0
 - pytest >= 7.2.1
 - scikit_learn >= 1.2.1
 - scipy >= 1.10.0
 - seaborn >= 0.12.2
 - setuptools >= 65.5.0
 - xgboost >= 1.7.3
 - iminuit >= 1.20.0
 - setuptools>=49.2.1
 - xgboost>=1.4.0
 
### For cosmology metric:

 - cmdstanpy>=1.1.0
 
### For documentation:
 
  - sphinx>=2.1.2

# Install

The current version runs in Python-3.7 or higher and it was not tested on Windows.  

We recommend that you work within a [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/).  
 
You will need to install the `Python` package ``virtualenv``. In MacOS or Linux, do

    >> python3 -m pip install --user virtualenv

Navigate to a ``env_directory`` where you will store the new virtual environment and create it  

    >> python3 -m venv RESSPECT

> Make sure you deactivate any ``conda`` environment you might have running before moving forward.   

Once the environment is set up you can activate it,

    >> source <env_directory>/bin/activate

You should see a ``(RESSPECT)`` flag in the extreme left of terminal command line.   

Next, clone this repository in another chosen location:  

    (RESSPECT) >> git clone https://github.com/COINtoolbox/RESSPECT.git

Navigate to the repository folder and do  

    (RESSPECT) >> pip install -r requirements.txt


You can now install this package with:  

    (RESSPECT) >>> python setup.py install

> You may choose to create your virtual environment within the folder of the repository. If you choose to do this, you must remember to exclude the virtual environment directory from version control using e.g., ``.gitignore``.   
