{"id":24894690,"url":"https://github.com/flixOpt/flixOpt","last_synced_at":"2025-10-16T10:30:17.036Z","repository":{"id":62153776,"uuid":"540378857","full_name":"flixOpt/flixopt","owner":"flixOpt","description":"Vector based Energy Optimization Framework","archived":false,"fork":false,"pushed_at":"2025-10-13T23:05:16.000Z","size":14892,"stargazers_count":11,"open_issues_count":37,"forks_count":9,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-10-14T12:07:35.240Z","etag":null,"topics":["climate-change","energy","energy-system","energy-system-modeling","energy-systems","linear-programming","mathematical-modelling","milp","mixed-integer-linear-programming","modeling","optimisation","optimization","python","renewables"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flixOpt.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-09-23T09:58:32.000Z","updated_at":"2025-10-13T23:05:20.000Z","dependencies_parsed_at":"2023-11-24T08:23:36.295Z","dependency_job_id":"4dc37397-2190-40ce-9315-10cb24a8a579","html_url":"https://github.com/flixOpt/flixopt","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/flixOpt/flixopt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flixOpt%2Fflixopt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flixOpt%2Fflixopt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flixOpt%2Fflixopt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flixOpt%2Fflixopt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flixOpt","download_url":"https://codeload.github.com/flixOpt/flixopt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flixOpt%2Fflixopt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279178867,"owners_count":26120304,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-16T02:00:06.019Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["climate-change","energy","energy-system","energy-system-modeling","energy-systems","linear-programming","mathematical-modelling","milp","mixed-integer-linear-programming","modeling","optimisation","optimization","python","renewables"],"created_at":"2025-02-01T19:02:38.116Z","updated_at":"2025-10-16T10:30:17.030Z","avatar_url":"https://github.com/flixOpt.png","language":"Python","readme":"# FlixOpt: Energy and Material Flow Optimization Framework\n\n[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://flixopt.github.io/flixopt/latest/)\n[![Build Status](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml/badge.svg)](https://github.com/flixOpt/flixopt/actions/workflows/python-app.yaml)\n[![PyPI version](https://img.shields.io/pypi/v/flixopt)](https://pypi.org/project/flixopt/)\n[![PyPI status](https://img.shields.io/pypi/status/flixopt.svg)](https://pypi.org/project/flixopt/)\n[![Python Versions](https://img.shields.io/pypi/pyversions/flixopt.svg)](https://pypi.org/project/flixopt/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![PyPI downloads](https://img.shields.io/pypi/dm/flixopt)](https://pypi.org/project/flixopt/)\n[![GitHub last commit](https://img.shields.io/github/last-commit/flixOpt/flixopt)](https://github.com/flixOpt/flixopt/commits/main)\n[![GitHub issues](https://img.shields.io/github/issues/flixOpt/flixopt)](https://github.com/flixOpt/flixopt/issues)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/flixOpt/flixopt/main.svg)](https://results.pre-commit.ci/latest/github/flixOpt/flixopt/main)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![Powered by linopy](https://img.shields.io/badge/powered%20by-linopy-blue)](https://github.com/PyPSA/linopy/)\n[![Powered by xarray](https://img.shields.io/badge/powered%20by-xarray-blue)](https://xarray.dev/)\n[![DOI](https://img.shields.io/badge/DOI-10.18086%2Feurosun.2022.04.07-blue)](https://doi.org/10.18086/eurosun.2022.04.07)\n[![GitHub stars](https://img.shields.io/github/stars/flixOpt/flixopt?style=social)](https://github.com/flixOpt/flixopt/stargazers)\n\n---\n\n**FlixOpt is a Python framework for optimizing energy and material flow systems** - from district heating networks to industrial production lines, from renewable energy portfolios to supply chain logistics.\n\n**Start simple, scale complex:** Build a working optimization model in minutes, then progressively add detail - multi-period investments, stochastic scenarios, custom constraints - without rewriting your code.\n\n---\n\n## 🚀 Quick Start\n\n```bash\npip install flixopt\n```\n\nThat's it! FlixOpt comes with the [HiGHS](https://highs.dev/) solver included. You're ready to optimize.\n\n**The basic workflow:**\n\n```python\nimport flixopt as fx\n\n# 1. Define your system structure\nflow_system = fx.FlowSystem(timesteps)\nflow_system.add_elements(buses, components, effects)\n\n# 2. Create and solve\ncalculation = fx.FullCalculation(\"MyModel\", flow_system)\ncalculation.solve()\n\n# 3. Analyze results\ncalculation.results.solution\n```\n\n**Get started with real examples:**\n- 📚 [Full Documentation](https://flixopt.github.io/flixopt/latest/)\n- 💡 [Examples Gallery](https://flixopt.github.io/flixopt/latest/examples/) - Complete working examples from simple to complex\n- 🔧 [API Reference](https://flixopt.github.io/flixopt/latest/api-reference/)\n\n---\n\n## 🌟 Why FlixOpt?\n\n### Progressive Enhancement - Your Model Grows With You\n\n**Start simple:**\n```python\n# Basic single-period model\nflow_system = fx.FlowSystem(timesteps)\nboiler = fx.Boiler(\"Boiler\", eta=0.9, ...)\n```\n\n**Add complexity incrementally:**\n- **Investment decisions** → Add `InvestParameters` to components\n- **Multi-period planning** → Add `periods` dimension to FlowSystem\n- **Uncertainty modeling** → Add `scenarios` dimension with probabilities\n- **Custom constraints** → Extend with native linopy syntax\n\n**No refactoring required.** Your component definitions stay the same - periods, scenarios, and features are added as dimensions and parameters.\n\n→ [Learn more about multi-period and stochastic modeling](https://flixopt.github.io/flixopt/latest/user-guide/mathematical-notation/dimensions/)\n\n### For Everyone\n\n- **Beginners:** High-level components that \"just work\"\n- **Experts:** Full access to modify models with linopy\n- **Researchers:** Quick prototyping with customization options\n- **Engineers:** Reliable, tested components without black boxes\n- **Students:** Clear, Pythonic interfaces for learning optimization\n\n### Key Features\n\n**Multi-criteria optimization:** Model costs, emissions, resource use - any custom metric. Optimize single objectives or use weighted combinations and ε-constraints.\n→ [Effects documentation](https://flixopt.github.io/flixopt/latest/user-guide/mathematical-notation/effects-penalty-objective/)\n\n**Performance at any scale:** Choose calculation modes without changing your model - Full, Segmented, or Aggregated (using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam)).\n→ [Calculation modes](https://flixopt.github.io/flixopt/latest/api-reference/calculation/)\n\n**Built for reproducibility:** Self-contained NetCDF result files with complete model information. Load results months later - everything is preserved.\n→ [Results documentation](https://flixopt.github.io/flixopt/latest/api-reference/results/)\n\n**Flexible data operations:** Transform FlowSystems with xarray-style operations (`sel()`, `resample()`) for multi-stage optimization.\n\n---\n\n## 🎯 What is FlixOpt?\n\n### A General-Purpose Flow Optimization Framework\n\nFlixOpt models **any system involving flows and conversions:**\n\n- **Energy systems:** District heating/cooling, microgrids, renewable portfolios, sector coupling\n- **Material flows:** Supply chains, production lines, chemical processes\n- **Integrated systems:** Water-energy nexus, industrial symbiosis\n\nWhile energy systems are our primary focus, the same foundation applies universally. This enables coupling different system types within integrated models.\n\n### Modern Foundations\n\nBuilt on [linopy](https://github.com/PyPSA/linopy/) and [xarray](https://github.com/pydata/xarray), FlixOpt delivers **performance** and **transparency**. Full access to variables, constraints, and model structure. Extend anything with native linopy syntax.\n\n### Our Position\n\nWe bridge the gap between high-level strategic models (like [FINE](https://github.com/FZJ-IEK3-VSA/FINE)) and low-level dispatch tools - similar to [PyPSA](https://docs.pypsa.org/latest/). FlixOpt is the sweet spot for detailed operational planning and long-term investment analysis in the **same framework**.\n\n### Academic Roots\n\nOriginally developed at [TU Dresden](https://github.com/gewv-tu-dresden) for the SMARTBIOGRID project (funded by the German Federal Ministry for Economic Affairs and Energy, FKZ: 03KB159B). FlixOpt evolved from the MATLAB-based flixOptMat framework while incorporating best practices from [oemof/solph](https://github.com/oemof/oemof-solph).\n\n---\n\n## 🛣️ Roadmap\n\n**FlixOpt aims to be the most accessible, flexible, and universal Python framework for energy and material flow optimization.** We believe optimization modeling should be approachable for beginners yet powerful for experts, minimizing context switching between different planning horizons.\n\n**Current focus:**\n- Enhanced component library (sector coupling, hydrogen, thermal networks)\n- Examples showcasing multi-period and stochastic modeling\n- Advanced result analysis and visualization\n\n**Future vision:**\n- Modeling to generate alternatives (MGA) for robust decision-making\n- Advanced stochastic optimization (two-stage, CVaR)\n- Community ecosystem of user-contributed components\n\n→ [Full roadmap and vision](https://flixopt.github.io/flixopt/latest/roadmap/)\n\n---\n\n## 🛠️ Installation\n\n### Basic Installation\n\n```bash\npip install flixopt\n```\n\nIncludes the [HiGHS](https://highs.dev/) solver - you're ready to optimize immediately.\n\n### Full Installation\n\nFor additional features (interactive network visualization, time series aggregation):\n\n```bash\npip install \"flixopt[full]\"\n```\n\n### Solver Support\n\nFlixOpt supports many solvers via linopy: **HiGHS** (included), **Gurobi**, **CPLEX**, **CBC**, **GLPK**, and more.\n\n→ [Installation guide](https://flixopt.github.io/flixopt/latest/getting-started/)\n\n---\n\n## 🤝 Contributing\n\nFlixOpt thrives on community input. Whether you're fixing bugs, adding components, improving docs, or sharing use cases - **we welcome your contributions.**\n\n→ [Contribution guide](https://flixopt.github.io/flixopt/latest/contribute/)\n\n---\n\n## 📖 Citation\n\nIf FlixOpt supports your research or project, please cite:\n\n- **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)\n- **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)\n\n---\n\n## 📄 License\n\nMIT License - See [LICENSE](https://github.com/flixopt/flixopt/blob/main/LICENSE) for details.\n","funding_links":[],"categories":["Energy Systems"],"sub_categories":["Energy System Modeling Frameworks"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FflixOpt%2FflixOpt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FflixOpt%2FflixOpt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FflixOpt%2FflixOpt/lists"}