This guide will help you install FlixOpt, understand its basic concepts, and run your first optimization model.
Install FlixOpt directly into your environment using pip:
pip install flixoptThis provides the core functionality with the HiGHS solver included.
For all features including interactive network visualizations and time series aggregation:
pip install "flixopt[full]"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()For advanced logging configuration, you can use Python's standard logging module directly:
import logging
logging.basicConfig(level=logging.DEBUG)For more details on logging configuration, see the [CONFIG.Logging][flixopt.config.CONFIG.Logging] documentation.
Working with FlixOpt follows a general pattern:
- Create a [
FlowSystem][flixopt.flow_system.FlowSystem] with a time series - Define [
Effects][flixopt.effects.Effect] (costs, emissions, etc.) - Define [
Buses][flixopt.elements.Bus] as connection points in your system - Add [
Components][flixopt.components] like converters, storage, sources/sinks with their Flows - Run [
Optimizations][flixopt.optimization] to optimize your system - Analyze [
Results][flixopt.results] using built-in or external visualization tools
Now that you've installed FlixOpt and understand the basic workflow, you can:
- Learn about the core concepts of flixopt
- Explore some examples
- Check the API reference for detailed documentation