Installation

Cardiotensor is a powerful and user-friendly toolkit for analyzing the orientation of cardiomyocites fibers in the heart

Prerequisites

• Python 3.10 or higher

Installing with pip recommended

cardiotensor is published as a Python package and can be installed with pip, ideally by using a virtual environment. Open up a terminal and install cardiotensor with:

pip install cardiotensor

Installing from Source

To install cardiotensor from source, follow these steps:

1. Clone the repository from GitHub:

   $ git clone https://github.com/JosephBrunet/cardiotensor.git
   

2. Navigate to the cloned repository directory:

   $ cd cardiotensor
   

3. Install the package using pip:

   $ pip install -e .  # (1)!
   

   1. The -e flag in pip install -e . installs the package in editable mode, allowing changes to the source code to be immediately reflected without reinstallation.

Uninstallation

If you need to remove cardiotensor from your system, follow these steps:

$ pip uninstall cardio-tensor

This should remove cardiotensor from your environment.