Obtaining Thetis

Thetis requires installation of Firedrake (available for Ubuntu, Mac, and in principle other Linux and Linux-like systems) and must be run from within the Firedrake virtual environment.

Installing Firedrake

You can install Firedrake by following the download documentation on the Firedrake website.

Note

Installing PETSc and Firedrake can take up to 30 minutes depending on the system.

After installation, in order to use Firedrake and install Thetis you need to activate the Firedrake virtualenv:

source <your-firedrake-venv-dir>/bin/activate

Warning

You should check that the Firedrake install has been successful by running:

firedrake-check

Installing Thetis

You can install Thetis in your Firedrake installation by activating the Firedrake virtualenv and running:

pip install git+https://github.com/thetisproject/thetis.git

Editable install

If you want to install Thetis from a local checkout of the repository that you can directly edit, update (pull) from GitHub, switch branches, etc., it is recommended to use an editable install using:

git clone https://github.com/thetisproject/thetis
pip install -e <path_to_thetis>

If you have SSH keys set up with GitHub, you can use the SSH-based clone instead:

git clone git@github.com:thetisproject/thetis
pip install -e <path_to_thetis>

An IDE such as PyCharm will not recognize Thetis when installed in this fashion for any project outside the cloned repository, as the source is not in site-packages. It will still run, and if you would like to enable full code navigation, you can add the Thetis cloned repository as a content root, then add the thetis sub-directory as a sources root.

Alternative installation methods

As well as being installable through pip, Firedrake also provides Docker containers which typically contain the latest Thetis at the time of release.

If there are any problems with the installation of Firedrake and Thetis, the Slack workspace for Firedrake contains both the general channel for Firedrake and a specific channel for Thetis. GitHub can also be used to report issues. Please follow this link for contact details and we will be happy to help.