Installation#

This guide describes the step-by-step process to install tilepy and its dependencies.

Note

tilepy is a toolkit designed to simulate observations based on gravitational wave (GW) skymaps, and to schedule follow-up observations (gamma-ray bursts, neutrinos, and optical transients) with both space- and ground-based telescopes, such as HESS, LST, and other CTA telescopes.

We strongly recommend installing tilepy inside a virtual environment (conda or venv) to avoid dependency conflicts.

Requirements

You will need the following:

Python >= 3.9

Conda

or

virtualenv

  • (Optional) mamba for faster environment setup

Environment setup
conda create -n tilepy_env python=3.9
conda activate tilepyenv

python -m venv tilepy_venv
source tilepy_venv/bin/activate
pip install --upgrade pip
Install tilepy

Recommended

The recommended way to install tilepy is using pip:

$ pip install tilepy

Unreleased version

If you want to use the latest version of tilepy, you can install the current main branch directly from GitHub:

$ pip install git+https://github.com/astro-transients/tilepy.git@main

Development install

To install tilepy in development mode, run:

git clone https://github.com/astro-transients/tilepy.git
cd tilepy
conda env create -n tilepyenv -f environment.yml
conda activate tilepyenv
pip install -e .

Warning

Troubleshooting MOCpy Installation (If Needed)

If you have issues with the mocpy package when using conda, try installing it separately with pip after creating your environment:

$ pip install mocpy
Verify your installation
$ python -c "import tilepy; print(tilepy.__version__)"

If no error appears and the version number is printed, your installation is correct!

Note

  • Dependencies are automatically managed if you use the provided environment.

  • For advanced usage (simulations, scripts, or examples), check the examples/ directory.

See also

  • Open an issue on the tilepy on GitHub

  • Contact the dev team at: Contact tilepy Team

  • Join the forum: tilepy Forum