Installation

Pre-Requisites

Python 3.8 or higher
pip package manager

Install directly from GitHub

Currently, the fastest way to install the package is done via GitHub.

pip install git+https://github.com/CASTOR-telescope/ETC.git

Install from source

You can obtain the full pacakge source code either through cloning from GitHub or downloading the zipped source code from releases.

Once downloaded, navigate to the /ETC folder and install the package via the following command:

pip install .

You can also attempt to build the wheel files locally by running the following commands:

pip install --upgrade build
python -m build

Install in develop mode

If you want to install in develop mode, use:

pip install -e .

In develop mode, the installation of the package simply links back to the castor_etc folder itself, meaning any changes made to this package will be reflected in your environment.

Additional installs

Transit models

If you are doing transit simulations, then after installing the Python package, you will need to download these stellar models into a directory. When you are using getStarData() or use_gaia_spectrum() in spectrum.py and when you are using the Observation class in transit.py, you will need to set the stellar_model_dir parameter in these functions/class to the directory containing the stellar models on your local machine.