TDAstro

Time-Domain Forward-Modeling for the Rubin Era

Dev Guide - Getting Started

Before installing any dependencies or writing code, it's a great idea to create a virtual environment such as venv

>> python3 -m venv ~/envs/tdastro
>> source ~/envs/tdastro/bin/activate

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

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

Acknowledgements

This project is supported by Schmidt Sciences.