Welcome to refitt’s documentation!

The Reccomender Engine for Intelligent Tracking (REFITT) is a reccomender engine that autonomously designs optimal observing strategies in real time that utilize the diverse capabilities provided by different telescopes and instruments, weighted by their respective costs vs. benefits to, to achieve community-directed scientific objectives. Unlike existing follow-up programs that focus on detailed characterization of individual supernovae, REFITT prioritizes observations that maximize expected information gain of physical model parameters, enabling improved population-level inference from LSST supernova data through more efficient use of limited follow-up resources.

Dev Guide - Getting Started

Before installing any dependencies or writing code, it’s a great idea to create a virtual environment. LINCC-Frameworks engineers primarily use conda to manage virtual environments. If you have conda installed locally, you can run the following to create and activate a new environment.

>> conda create env -n <env_name> python=3.11
>> conda activate <env_name>

Once you have created a new environment, you can install this project for local development using the following commands:

>> pip install -e .'[dev]'
>> pre-commit install
>> conda install pandoc

Notes:

1. The single quotes around '[dev]' may not be required for your operating system.

2. pre-commit install will initialize pre-commit for this local repository, so that a set of tests will be run prior to completing a local commit. For more information, see the Python Project Template documentation on pre-commit.

3. Installing pandoc allows you to verify that automatic rendering of Jupyter notebooks into documentation for ReadTheDocs works as expected. For more information, see the Python Project Template documentation on Sphinx and Python Notebooks.