Install¶

uv is the preferred tool to install LLG3D, but you can also use pip. In any case, it is strongly recommended to isolate your installation in a virtual environment.

According to the solver version you plan to use, you will need to install different dependencies.

Install Numpy (sequential) solver¶

uv tool install llg3d

pip

pip install llg3d

Install MPI solver¶

Install MPI¶

MacOS

brew install open-mpi

Debian/Ubuntu

apt-get install openmpi

Install LLG3D package¶

uv tool install llg3d[mpi]

pip

pip install llg3d[mpi]

Install OpenCL solver¶

Install OpenCL¶

MacOS

brew install opencl

Debian/Ubuntu

apt-get install opencl

Install LLG3D solver¶

uv tool install llg3d[opencl]

pip

pip install llg3d[opencl]

Install LLG3D in editable mode¶

Clone the repository¶

git clone git@gitlab.math.unistra.fr:llg3d/llg3d.git
cd llg3d/

Create and activate a virtual environment¶

uv venv
source .venv/bin/activate

pip

virtualenv .venv
source .venv/bin/activate

Install in editable mode¶

uv sync --all-extras

pip

pip install -e .[mpi,opencl]