Before installing TARDIS, please check its requirements. We provide instructions for installing TARDIS using Anaconda. If you encounter problems, consult the troubleshooting section. Once you have installed TARDIS, check out Quickstart Guide for instructions of how to perform simple TARDIS calculations.
We strongly recommond to install TARDIS within an Anaconda environment and to always use the lastest github development version.
You can see a list of all the requirements of TARDIS in the environment definition file.
TARDIS is using astropy’s excellent installation helpers and thus uses similar instructions to astropy.
Installing TARDIS with Anaconda¶
We highly recommend using the Anaconda python environment to install TARDIS (or
any other scientific packages for that matter). Anaconda has the advantage of
being an isolated environment that can be set to be the default one, but by no
means will mess with your other environments. It will also work on computers
root-rights are not available. Use these instructions to install Anaconda on your
machine. The next step is to create an environment for TARDIS that contains all
of the necessary packages (this ensures that TARDIS requirements won’t clash
with any other python installs on disc:
First, download the environment definition file from:
To create the environment, change to the directory that you downloaded the environment definition file and run:
conda-env create -f tardis_env27.yml
Then to activate this environment simply do:
source activate tardis
and after you are done with TARDIS you can deactivate:
One does not need to recreate the environment, but simply activate it every time TARDIS is used.
Since TARDIS has reached a mature state, we recommend always installing the latest development version:
pip install git+https://github.com/tardis-sn/tardis
Alternatively, you can manually clone our repository and install TARDIS by
git clone https://github.com/tardis-sn/tardis.git cd tardis python setup.py build install
Installation Troubles (FAQ)¶
We highly encourage with any installation problems to try the recommended install method because this often fix problems. Here are some common problems when installing and their fixes:
Problem: While building tardis via
python setup.py build you
may encounter the following error:
error: tardis/montecarlo/montecarlo.c: Could not find C file tardis/montecarlo/montecarlo.c for Cython file tardis/montecarlo/montecarlo.pyx when building extension tardis.montecarlo.montecarlo. Cython must be installed to build from a git checkout.
Solution: There are several solutions to this problem. A clean checkout will
help. To clean up your repository please try
python setup.py clean and
git clean -dfx (WARNING will delete any non tardis file in that directory)
This will often clean this problem. If it still persists:
Go into the tardis/montecarlo directory and build montecarlo.c by hand:
python setup.py build should run without problems.