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:
⚡ Fastest & simplest install – uv recommended
uv installs tilepy and all its dependencies in a single command, with no environment setup needed.
curl -LsSf https://astral.sh/uv/install.sh | sh
git clone https://github.com/astro-transients/tilepy.git
cd tilepy
uv sync --python 3.11
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
git clone https://github.com/astro-transients/tilepy.git
cd tilepy
uv sync --python 3.11
Once installed, run tilepy commands directly with uv run – no need to activate any environment:
uv run python -c "import tilepy; print(tilepy.__version__)"
uv run Tiling_Observations ...
source .venv/bin/activate
python -c "import tilepy; print(tilepy.__version__)"
Other installation methods
Prefer another tool? Choose one of the following:
1. Create and activate the environment:
conda create -n tilepy_env python=3.11
conda activate tilepy_env
2. Install tilepy:
pip install tilepy
1. Create and activate the environment:
python -m venv tilepy_venv
source tilepy_venv/bin/activate # Linux/macOS
tilepy_venv\Scripts\activate # Windows
pip install --upgrade pip
2. Install tilepy:
pip install tilepy
Unreleased version
Install the current main branch directly from GitHub:
$ pip install git+https://github.com/astro-transients/tilepy.git@main
Warning
Troubleshooting MOCpy
If you have issues with mocpy under conda, install it separately:
$ pip install mocpy
Developer install
For contributors who want to modify the source code:
git clone https://github.com/astro-transients/tilepy.git
cd tilepy
uv sync --python 3.11
git clone https://github.com/astro-transients/tilepy.git
cd tilepy
pip install -e ".[dev]"
Verify your installation
uv run python -c "import tilepy; print(tilepy.__version__)"
$ 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.