Skip to content

Latest commit

 

History

History
81 lines (47 loc) · 3.01 KB

README.md

File metadata and controls

81 lines (47 loc) · 3.01 KB
Raw

resspect

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) and the LSST Dark Energy Science Collaboration (DESC).

This work grew from activities developed within the COIN Residence Program #4, using as a starting point their ActSNClass software.

The active learning and telescope resources pipeline is described in Kennamer et al, 2020. The pre-processed data set used to obtain the results shown in the paper is available through zenodo at de Souza et al., 2020.

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.

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.

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.