Installation

Warning

  • TARDIS is only supported on macOS and GNU/Linux. Windows users can run TARDIS from our official Docker image (coming soon), WSL or a Virtual Machine.

  • TARDIS packages and dependencies are distributed only through the conda package management system, therefore installation requires Anaconda or Miniconda to be installed on your system.

Install with lockfiles

Conda lockfiles are platform-specific dependency files that produce repeteable environments. These files are generated on every new release. We strongly recommend installing TARDIS using this method by following the steps described below.

  1. Download the latest lockfile for your operating system from our releases section, or run the following command while replacing {platform} with linux or osx as appropriate.

$ wget -q https://github.com/tardis-sn/tardis/releases/latest/download/conda-{platform}-64.lock

  1. Create and activate the tardis environment.

$ conda create --name tardis --file conda-{platform}-64.lock
$ conda activate tardis

    1. Non-developers can install the latest release from conda-forge with the --no-deps flag,

      $ conda install tardis-sn --channel conda-forge --no-deps

      or trying the most recent, unreleased changes from upstream.

      $ pip install git+https://github.com/tardis-sn/tardis.git@master

    2. Instead, developers should fork the repository, configure GitHub to work with SSH keys, set up the upstream remote, and install the package in development mode.

      $ git clone git@github.com:<username>/tardis.git
$ cd tardis
$ git remote add upstream git@github.com:tardis-sn/tardis.git
$ git fetch upstream
$ git checkout upstream/master
$ pip install -e .

      Note

      The complete developer guidelines can be found here.

  2. Once finished working, you can deactivate your environment.

$ conda deactivate

You are ready! From now on, just activate the tardis environment before working with the TARDIS package.

Install from package

It’s also possible to install TARDIS by pulling the conda-forge package into a clean environment. However, we still encourage using lockfiles to ensure reproducibility of scientific results.

$ conda create --name tardis-forge tardis-sn --channel conda-forge

Environment update

To update the environment after a new release, download the latest lockfile and run conda update.

$ conda update --name tardis --file conda-{platform}-64.lock