Installation#
This page will guide you through the installation of Tudat(Py). The installation is supported exclusively through the use of a conda
package manager, such as Miniconda or Anaconda.
Attention
Windows users must install Anaconda; for new users in general we recommend Anaconda
To install Anaconda or Miniconda on your system, see the Anaconda Installation of Miniconda Installation guide provided in their documentation.
For more details on how to use conda, please refer to our detailed guide (Getting Started with Conda) and the references therein.
Installing Tudat(Py)#
To install Tudat(Py), we recommend the use of a terminal (command line) interface. On Unix system (Linux and Mac), conda should already be available within the terminal; you can open your terminal directly. On Windows, you can find a program called Anaconda Prompt in the Windows search. Using conda in the Anaconda Prompt is equivalent to the terminal use of conda in a Unix terminal.
Open a terminal. Then first verify that conda is installed by executing the following command:
conda --version
Next ensure that conda is up-to-date.
conda update conda
Download this environment.yaml (yaml). Then, in your terminal navigate to the directory containing this file and execute the following command (see below for tips on using the command line):
conda env create -f environment.yaml
With the conda environment now installed, you can activate it to work in it using:
conda activate tudat-space
Note
At this point, you may choose to install the development version of TudatPy, which is a conda package that is updated as soon as changes are merged to the development branch of the code on GitHub.
To do so, you can download the environment-dev.yaml (yaml), and use:
conda env create -f environment-dev.yaml
conda activate tudat-space-dev
to install and activate the tudat-space-dev environment.
For more help on getting started with the command-line interface (CLI), you could start with a tutorial.
Congratulations! You have now installed Tudat and TudatPy and are ready to start running your simulations and analyses! We recommend you get started by having a look at our Examples.
If there are any issues with the installation, the examples, or if you have any question or comments on Tudat, please use our Github discussion forum.
Note
New to the command-line? The following commands may be useful to you:
Command effect |
Unix (Linux & macOS) |
Windows |
Enter a directory using a path (relative or absolute) |
|
|
Go back to the parent directory |
|
|
List the contents of the current working directory |
|
|
For more help on getting started with the command-line interface (CLI), you could start with a tutorial.
Building your own TudatPy kernel#
If you would prefer to not use a conda package, but instead build your own tudatpy kernel from the source code, clone the tudat-bundle repository from here and follow the instructions in the README. To build the latest version of the kernel, switch both the tudat and tudatpy repositories to the develop branch in step 3 of the README.
Note
This workflow is not recommended for new users.