Installation

Important

In order to benefit from the massive speedup provided by Taichi, it is mandatory to install the package using Python 3.12.

Basic Installation

The package is available on PyPI, making installation straightforward. Depending on your package manager of choice, you can install VIVyD using one of the following commands:

uv

uv add vivyd

pip

pip install vivyd

You can check that the installation was successful by running:

python -c "import vivyd; print(f'VIVyD successfully installed with version {vivyd.__version__}')"

Development Setup

To work on the source code of this project, clone this repository to your local machine.

HTTPS

git clone https://gitlab.uliege.be/structural-and-stochastic-dynamics/vivyd.git

SSH

git clone git@gitlab.uliege.be:structural-and-stochastic-dynamics/vivyd.git

Then, navigate into the project directory:

cd vivyd

Next, it is recommended to create a virtual environment to manage dependencies.

uv

uv sync

pip

pip install -e .

You can check that the installation was successful by running:

python -c "import vivyd; print(f'VIVyD successfully installed with version {vivyd.__version__}')"