User Guide

Comprehensive guides for using LumiX effectively in your optimization projects.

User Guide Topics

• Core Concepts
  • Introduction
  • Philosophy
  • Core Components
  • Component Details
  • Data Flow
  • Type Safety
  • Fluent API
  • Next Steps
• Using Solvers
  • Introduction
  • Philosophy
  • Core Components
  • Quick Start
  • Components Details
  • Guide Sections
  • Next Steps
• Indexing Guide
  • Overview
  • Core Concepts
  • Why Indexing Matters
  • Quick Start Examples
  • Common Patterns
  • Best Practices
  • Performance Considerations
  • Next Steps
  • See Also
• Nonlinear Terms
  • Introduction
  • Philosophy
  • Core Components
  • Quick Start Example
  • Integration with Linearization Module
  • Component Guides
  • Type Safety and IDE Support
  • Linearization Methods
  • Best Practices
  • Next Steps
• Linearization Concepts
  • Introduction
  • Philosophy
  • Supported Nonlinear Terms
  • How Linearization Works
  • Configuration
  • Quick Examples
  • Performance Considerations
  • Component Details
  • Next Steps
• Utils Module Guide
  • Introduction
  • Module Components
  • Common Use Cases
  • Best Practices
  • Performance Considerations
  • Next Steps
• Solution Handling
  • Introduction
  • Philosophy
  • Components
  • Quick Example
  • Detailed Guides
  • Topics Covered
  • Best Practices
  • Common Patterns
  • Next Steps
• Analysis Tools
  • Introduction
  • Philosophy
  • Analysis Tools Overview
  • Choosing the Right Tool
  • Workflow Integration
  • Component Details
  • Next Steps
• Goal Programming
  • Introduction
  • Philosophy
  • Quick Example
  • How It Works
  • Components Overview
  • Detailed Guides
  • Topics Covered
  • Best Practices
  • Common Patterns
  • Next Steps

Core Module

The Core Concepts section covers the fundamental concepts and components.

Topics Covered:

• Data-driven modeling philosophy

• Variable families and indexing

• Constraint definition and expansion

• Expression building (linear, quadratic, non-linear)

• Model construction and solving

Solvers Module

The Using Solvers section covers using LumiX’s unified solver interface.

Topics Covered:

• Using the LXOptimizer class

• Choosing the right solver for your problem

• Configuring solver parameters

• Understanding solver capabilities

• Advanced features (warm start, callbacks, sensitivity analysis)

• Switching between solvers seamlessly

Indexing Module

The Indexing Guide section covers multi-dimensional indexing capabilities.

Topics Covered:

• Single-model and multi-model indexing

• Index dimensions and cartesian products

• Filtering strategies (per-dimension and cross-dimension)

• Type-safe multi-dimensional variables

• Sparse indexing patterns

Nonlinear Module

The Nonlinear Terms section covers nonlinear term definitions and modeling.

Topics Covered:

• Absolute value terms for deviation minimization

• Min/max operations over alternatives

• Bilinear products (x * y) with automatic linearization

• Indicator (conditional) constraints

• Piecewise-linear approximations of nonlinear functions

• Integration with automatic linearization

Linearization Module

The Linearization Concepts section covers automatic linearization of nonlinear terms.

Topics Covered:

• Automatic detection and linearization of nonlinear terms

• Bilinear product linearization (McCormick, Big-M, Binary AND)

• Piecewise-linear function approximation (SOS2, Incremental)

• Pre-built nonlinear functions (exp, log, sqrt, power, sigmoid, trig)

• Configuration and accuracy tuning

• Integration with solver capabilities

Utils Module

The Utils Module Guide section covers utility components for enhanced functionality.

Topics Covered:

• Enhanced logging for optimization models

• Type-safe ORM integration (SQLAlchemy, Django)

• Float-to-rational conversion for integer solvers

• Integration patterns and best practices

Solution Module

The Solution Handling section covers working with optimization solutions.

Topics Covered:

• Accessing variable values and solution metadata

• Goal programming solution handling

• Mapping solution values to ORM models

• Solution validation and export

Analysis Module

The Analysis Tools section covers post-optimization analysis and decision support tools.

Topics Covered:

• Sensitivity analysis with shadow prices and reduced costs

• Scenario analysis for systematic comparison of alternatives

• What-if analysis for interactive parameter exploration

• Bottleneck identification and resource allocation

• Multi-parameter analysis and trade-off exploration

Goal Programming Module

The Goal Programming section covers multi-objective optimization using goal programming.

Topics Covered:

• Converting hard constraints to soft constraints (goals)

• Weighted goal programming (single solve with priority weights)

• Sequential goal programming (lexicographic optimization)

• Constraint relaxation and deviation variables

• Building and combining goal programming objectives

• Working with goal programming solutions

Quick Start

New to LumiX? Start here:

1. Installation - Install LumiX

2. Quick Start Guide - Build your first model

3. Core Concepts - Understand core concepts

4. Examples - See working examples

Coming Soon

The following sections will be added in future updates:

Advanced Topics

• ORM integration patterns

• Custom solver configuration

• Performance optimization

• Debugging infeasible models

Stay Tuned

We’re actively working on expanding this documentation. Check back soon or:

• Browse the examples in the repository

• Read the API documentation

• Open an issue if you need specific guidance