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 repeatable 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://raw.githubusercontent.com/tardis-sn/tardis/master/conda-{platform}-64.lock

2. Create and activate the tardis environment.

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

3. 1. 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. Non-developers can install from specific releases using pip-

   $ pip install git+https://github.com/tardis-sn/tardis.git@{tag}
   

   For example-

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

   or trying the most recent, unreleased changes from upstream.

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

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

$ conda deactivate

From now on, just activate the tardis environment before working with the TARDIS package.

You have successfully installed TARDIS! 🎉 Please refer to Quickstart for TARDIS to start running simulations.

Environment update

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

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

Note

If you have installed the tardis package in development mode, you should ideally update your environment whenever you pull latest tardis code because the new code added might be using updated (or new) dependencies. If you don’t do that and your tardis installation seems broken, you can check if your environment requires update by comparing it against the latest environment file:

$ conda compare --name tardis tardis_env3.yml

Recommended approach:

We highly recommend deleting your existing environment and creating a new one using the latest lockfile whenever you need to update your environment after a new release.

Use the following conda command to remove your current tardis environment:

$ conda remove --name tardis --all

Now, you can create a new environment by following the steps given here.