Installation (with Mamba)

We recommend Mamba to install necessary dependencies and use the TATHU package.

1. First, install Mamba.

2. Clone the TATHU Repository:

   git clone https://github.com/uba/tathu.git
   

3. Go to the source code folder:

   cd tathu
   

4. Create a new environment with all necessary dependencies:

   mamba env create -f env.yml
   

5. Active the created environment (env-tathu):

   conda activate env-tathu
   

6. Install TATHU package:

   python -m pip install --no-deps .
   or
   python -m pip install --no-deps -e . # develop mode
   

7. Verify installation:

   python
   import tathu
   tathu.__version__
   

Installation (deprecated)

We recommend Miniconda and conda-forge channel to install necessary dependencies and use the TATHU package.

1. First, install Miniconda.

2. Add conda-forge channel and adjust channel_priority to strict:

   conda config --add channels conda-forge
   conda config --set channel_priority strict
   

3. Clone the TATHU Repository:

   git clone https://github.com/uba/tathu.git
   

4. Go to the source code folder:

   cd tathu
   

5. Create a new environment with all necessary dependencies:

   conda env create -f env.yml
   

6. Active the created environment (env-tathu):

   conda activate env-tathu
   

7. Install TATHU package:

   python -m pip install --no-deps .
   or
   python -m pip install --no-deps -e . # develop mode
   

8. Verify installation:

   python
   import tathu
   tathu.__version__
   

Build the Documentation

You can generate the documentation based on Sphinx with the following command:

sphinx-build -b html docs/sphinx/ docs/build/html/

The above command will generate the documentation in HTML and it will place it under:

docs/build/html/

You can open the above documentation in your favorite browser, as:

firefox docs/build/html/index.html