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

Prerequisites
------------

- Python >= 3.12
- pip (Python package manager)

Installation Methods
--------------------

Using pip (Recommended)
~~~~~~~~~~~~~~~~~~~~~~

The easiest way to install mini-causal is using pip:

.. code-block:: bash

   pip install mini-causal==0.4.2

From Source
~~~~~~~~~~~

To install from the source repository:

1. Clone the repository:

   .. code-block:: bash

      git clone https://github.com/Masemene-Matlakana-Benny/mini-causal.git
      cd mini-causal

2. Install in development mode:

   .. code-block:: bash

      pip install -e .

Virtual Environment (Recommended)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

It's recommended to use a virtual environment to isolate dependencies:

**Windows (PowerShell):**

.. code-block:: powershell

   python -m venv .venv
   .\.venv\Scripts\Activate.ps1
   pip install mini-causal==0.4.2

**macOS/Linux (bash):**

.. code-block:: bash

   python -m venv .venv
   source .venv/bin/activate
   pip install mini-causal==0.4.2

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

.. code-block:: bash

   pip install jupyter matplotlib seaborn

Verifying Installation
----------------------

After installation, you can verify it works:

.. code-block:: python

   import mini_causal
   print(mini_causal.__version__)

This should print the installed version without errors.