pyomo-solver-analyzer 0.1.0

Automatic constraint analysis and debugging for Pyomo linear solvers

PyomoDebugger

A constraint analysis and debugging toolkit for Pyomo, an open-source optimization modeling language in Python. This library provides tools for analyzing solver outputs, diagnosing infeasibility, and identifying binding constraints in linear optimization models.

Features

• Constraint Analysis: Identify tight constraints, slack variables, and sensitivity metrics
• Infeasibility Detection: Diagnose why models are infeasible
• Solver Diagnostics: Analyze solver outputs and optimization results
• Constraint Introspection: Deep inspection of constraint properties and relationships
• Performance Analysis: Identify performance bottlenecks and limiting factors

Installation

Install from PyPI:

pip install pyomo-solver-analyzer

Or install from source with development dependencies:

git clone https://github.com/jaimerp94/PyomoDebugger.git
cd PyomoDebugger
pip install -e ".[dev]"

Quick Start

from pyomo_solver_analyzer import SolverDiagnostics
import pyomo.environ as pyo

# Create and solve your Pyomo model
model = pyo.ConcreteModel()
# ... define your model ...
solver = pyo.SolverFactory('glpk')
solver.solve(model)

# Analyze the results
diagnostics = SolverDiagnostics(model)
report = diagnostics.generate_diagnostics_report()
print(report)

Documentation

• API Reference
• Architecture Guide
• Examples
• Mathematical Background

Development

For detailed development setup instructions, see DEVELOPMENT.md.

Project Structure

PyomoDebugger/
├── src/
│   └── pyomo_solver_analyzer/       # Main package
│       ├── __init__.py
│       ├── analyzer.py
│       ├── diagnostics.py
│       ├── introspection.py
│       └── unfeasibility.py
├── tests/                           # Test suite
├── docs/                            # Documentation
├── README.md
├── LICENSE
├── pyproject.toml                   # Project configuration
└── DEVELOPMENT.md

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for guidelines.

Before committing, ensure:

1. Code passes ruff linting: ruff check src/
2. Code passes mypy type checking: mypy src/
3. Tests pass: pytest tests/
4. Pre-commit hooks pass: pre-commit run --all-files

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For issues, questions, or feature requests, please open an issue on GitHub.

Citation

If you use this library in your research, please cite:

@software{pyomo_solver_analyzer,
  title={Pyomo Solver Analyzer},
  author={Martin, Jaime},
  year={2024},
  url={https://github.com/jaimerp94/PyomoDebugger}
}