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:

.. tab-set::

    .. tab-item:: uv

        .. code-block:: bash

            uv add vivyd

    .. tab-item:: pip

        .. code-block:: bash

            pip install vivyd

You can check that the installation was successful by running:

.. code-block:: bash

    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.

.. tab-set::

    .. tab-item:: HTTPS

        .. code-block:: bash

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

    .. tab-item:: SSH

        .. code-block:: bash

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

Then, navigate into the project directory:

.. code-block:: bash

    cd vivyd

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

.. tab-set::

    .. tab-item:: uv

        .. code-block:: bash

            uv sync

    .. tab-item:: pip

        .. code-block:: bash

            pip install -e .

You can check that the installation was successful by running:

.. code-block:: bash

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