Installation

We recommend setting up ehubX in a dedicated Python virtual environment to avoid conflicts with other packages. The step-by-step guide below is formulated using conda but can be adapted for other package managers or manual setup. Similarly, we use poetry for dependency management, which can be replaced with pip if preferred. Since ehubX relies on external MILP solvers, additionally ensure that you have a compatible solver installed and properly configured in your environment (see Specify solver).

1. Clone the ehubX repository.

2. Create a new virtual environment:

   conda create -n ehubx python=PYTHON_VERSION
   

   Make sure that the PYTHON_VERSION you choose is compatible with the current version of ehubX (see pyproject.toml).

3. Activate the environment:

   conda activate ehubx
   

4. Install poetry for dependency management:

   conda install -c conda-forge poetry
   

5. Navigate to the cloned ehubX directory and install using poetry:

   cd PATH_TO_EHUBX_REPO
   poetry install
   

6. Run any of the main scripts in the examples folder to verify the installation.