Installation

This section presents how to install the Canari libraty using either PyPi, or through a local installation for developpement purposes. Note that prior to installing, you should first create a Miniconda environement in order to ensure the compatibility with the pyTAGI external library.

Create Miniconda Environment

1. Install Miniconda by following these instructions.

2. Create a conda environment named canari:

   conda create --name canari python=3.10
   

3. Activate conda environment:

   conda activate canari
   

Installing from PyPi

1. Install pycanari package

   pip install pycanari
   

2. Install requirements

   pip install -r requirements.txt
   

3. (Optional) If facing errors installing the pytagi library in the requirements, do the following:

   conda install -c conda-forge libstdcxx-ng
   

Installing locally

1. Clone this repository:

   git clone https://github.com/Bayes-Works/canari.git
   cd canari
   

2. Create conda environment following the above instructions

3. Install requirements

   pip install -r requirements.txt
   

4. Install pycanari package

   pip install .