Installation

Prerequisites

  • Python >= 3.12

  • pip (Python package manager)

Installation Methods

From Source

To install from the source repository:

  1. Clone the repository:

    git clone https://github.com/Masemene-Matlakana-Benny/mini-causal.git
    cd mini-causal
    
  2. Install in development mode:

    pip install -e .
    

Dependencies

mini-causal has the following dependencies:

  • numpy>=1.26.0

  • scipy>=1.11.3

  • pandas>=2.1.1

  • scikit-learn>=1.3.0

These will be automatically installed when you install mini-causal via pip.

Optional Dependencies

For full functionality, you may also want to install:

  • jupyter: For running example notebooks

  • matplotlib: For visualization

  • seaborn: For enhanced plotting

pip install jupyter matplotlib seaborn

Verifying Installation

After installation, you can verify it works:

import mini_causal
print(mini_causal.__version__)

This should print the installed version without errors.