Skip to content

Installation

This guide covers installing flixOpt and its dependencies.

Basic Installation

Install flixOpt directly into your environment using pip:

pip install flixopt

This provides the core functionality with the HiGHS solver included.

Full Installation

For all features including interactive network visualizations and time series aggregation:

pip install "flixopt[full]"

Development Installation

If you want to contribute to flixOpt or work with the latest development version:

git clone https://github.com/flixOpt/flixopt.git
cd flixopt
pip install -e ".[full,dev,docs]"

Solver Installation

HiGHS (Included)

The HiGHS solver is included with flixOpt and works out of the box. No additional installation is required.

Gurobi (Optional)

For academic use, Gurobi offers free licenses:

  1. Register for an academic license at gurobi.com
  2. Install Gurobi: 
    pip install gurobipy
  3. Activate your license following Gurobi's instructions

FICO Xpress (Optional)

Xpress ships with a free Community license for small models (up to 5000 rows and columns combined). Academic and commercial licenses are available from FICO:

  1. Install Xpress: 
    pip install xpress
  2. For larger models, point Xpress to your license file (e.g. via the XPAUTH_PATH environment variable)
  3. Use it via fx.solvers.XpressSolver()

Version requirements

XpressSolver needs Xpress 9.0 or newer (for the TIMELIMIT control). Use linopy 0.5.8 or newer: older versions cannot return a solution when Xpress stops at the time limit.

Verification

Verify your installation by running:

import flixopt
print(flixopt.__version__)

Logging Configuration

flixOpt uses Python's standard logging module with optional colored output via colorlog. Logging is silent by default but can be easily configured:

from flixopt import CONFIG

# Enable colored console logging
CONFIG.Logging.enable_console('INFO')

# Or use a preset configuration for exploring
CONFIG.exploring()

Since flixOpt uses Python's standard logging, you can also configure it directly:

import logging

# Get the flixopt logger and configure it
logger = logging.getLogger('flixopt')
logger.setLevel(logging.DEBUG)
logger.addHandler(logging.StreamHandler())

For more details on logging configuration, see the CONFIG.Logging documentation.

Next Steps