2. Installation

The installation of the TetraX package requires python and a C compiler. For MacOs users we recommend the installation of the latest Anaconda package.

To install this package on a computer with administrator rights use

pip install git+https://gitlab.hzdr.de/micromagnetic-modeling/tetrax.git

On a cluster with no administrator rights you need to add the –user option:

pip install git+https://gitlab.hzdr.de/micromagnetic-modeling/tetrax.git --user

During the installation the pip package manager will check the dependencies and install all python related packages the TetraX uses.

NOTE: To avoid updating your packages, please create a python virtual environment, activate it and install both the Jupyter notebook as well as the TetraX in this virtual environment. After your finite element simulations are done you can deactivate your virtual environment.

To allow for 3D visualization in Jupyter notebooks, you additionally need to activate the k3d extension in your shell using

$ jupyter nbextension install --py --sys-prefix k3d
$ jupyter nbextension enable --py --sys-prefix k3d

Now you are ready to use TetraX in your python scripts or Jupyter notebook.

import tetrax as tx