Installation
============

To use Febio-Python, first install it using pip:

.. code-block:: console

   (.venv) $ pip install febio-python

For additional functionality, such as converting to `pyvista` or `vtk`, you can install the optional dependencies:

.. code-block:: console

   (.venv) $ pip install pyvista[all, trame]

Cloning the repository
----------------------

We are actively developing Febio-Python, so you may want to clone the repository to get the latest updates. 
To clone the repository, run the following command:

.. code-block:: console

   (.venv) $ git clone https://github.com/Nobregaigor/febio-python
   (.venv) $ cd febio-python
   (.venv) $ pip install -e .

Forking the repository
----------------------

If you want to contribute to Febio-Python, you can fork the repository and clone your fork.
To fork the repository, click on the "Fork" button on the top right corner of the repository page.
After forking the repository, clone your fork:

.. code-block:: console

   (.venv) $ git clone your_fork_url
   (.venv) $ cd febio-python
   (.venv) $ pip install -e .

Please, refer to the `Contributing` section for more information on how to contribute to Febio-Python.