{"id":357992,"name":"fluxopt","description":"Energy system optimization with linopy — detailed dispatch, scaled to multi period planning.","url":"https://github.com/fluxopt/fluxopt","last_synced_at":"2026-06-19T00:30:44.004Z","repository":{"id":338178965,"uuid":"1156664066","full_name":"fluxopt/fluxopt","owner":"fluxopt","description":"Successor of flixopt with a new datamodel","archived":false,"fork":false,"pushed_at":"2026-06-13T19:46:55.000Z","size":3322,"stargazers_count":2,"open_issues_count":38,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-14T23:20:39.043Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://fluxopt.readthedocs.io/","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/fluxopt.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":"2026-02-12T22:54:29.000Z","updated_at":"2026-06-13T19:46:05.000Z","dependencies_parsed_at":"2026-06-07T02:00:39.222Z","dependency_job_id":null,"html_url":"https://github.com/fluxopt/fluxopt","commit_stats":null,"previous_names":["fbumann/fluxopt"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/fluxopt/fluxopt","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxopt%2Ffluxopt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxopt%2Ffluxopt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxopt%2Ffluxopt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxopt%2Ffluxopt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluxopt","download_url":"https://codeload.github.com/fluxopt/fluxopt/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxopt%2Ffluxopt/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34386320,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"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"}},"owner":{"login":"fluxopt","name":"fluxopt","uuid":"291020290","kind":"organization","description":null,"email":null,"website":null,"location":null,"twitter":null,"company":null,"icon_url":"https://avatars.githubusercontent.com/u/291020290?v=4","repositories_count":1,"last_synced_at":"2026-06-05T14:12:27.310Z","metadata":{"has_sponsors_listing":false},"html_url":"https://github.com/fluxopt","funding_links":[],"total_stars":0,"followers":0,"following":0,"created_at":"2026-06-05T14:12:27.331Z","updated_at":"2026-06-05T14:12:27.331Z","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluxopt","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fluxopt/repositories"},"packages":[],"commits":{"message":"Repository syncing started."},"issues_stats":{"full_name":"fluxopt/fluxopt","html_url":"https://github.com/fluxopt/fluxopt","last_synced_at":null,"status":null,"issues_count":null,"pull_requests_count":null,"avg_time_to_close_issue":null,"avg_time_to_close_pull_request":null,"issues_closed_count":null,"pull_requests_closed_count":null,"pull_request_authors_count":null,"issue_authors_count":null,"avg_comments_per_issue":null,"avg_comments_per_pull_request":null,"merged_pull_requests_count":null,"bot_issues_count":null,"bot_pull_requests_count":null,"past_year_issues_count":null,"past_year_pull_requests_count":null,"past_year_avg_time_to_close_issue":null,"past_year_avg_time_to_close_pull_request":null,"past_year_issues_closed_count":null,"past_year_pull_requests_closed_count":null,"past_year_pull_request_authors_count":null,"past_year_issue_authors_count":null,"past_year_avg_comments_per_issue":null,"past_year_avg_comments_per_pull_request":null,"past_year_bot_issues_count":null,"past_year_bot_pull_requests_count":null,"past_year_merged_pull_requests_count":null,"created_at":"2026-06-16T01:00:30.021Z","updated_at":"2026-06-16T01:00:30.021Z","repository_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxopt%2Ffluxopt","issues_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/fluxopt%2Ffluxopt/issues","issue_labels_count":{},"pull_request_labels_count":{},"issue_author_associations_count":{},"pull_request_author_associations_count":{},"issue_authors":{},"pull_request_authors":{},"host":{"name":"GitHub","url":"https://github.com","kind":"github","last_synced_at":"2026-06-16T00:00:20.494Z","repositories_count":14809486,"issues_count":33142518,"pull_requests_count":109390554,"authors_count":11307488,"icon_url":"https://github.com/github.png","host_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories","owners_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/owners","authors_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors"},"past_year_issue_labels_count":{},"past_year_pull_request_labels_count":{},"past_year_issue_author_associations_count":{},"past_year_pull_request_author_associations_count":{},"past_year_issue_authors":{},"past_year_pull_request_authors":{},"maintainers":[],"active_maintainers":[]},"events":{"total":{},"last_year":{}},"keywords":[],"dependencies":[{"ecosystem":"pypi","filepath":"pyproject.toml","sha":null,"kind":"manifest","created_at":"2026-04-02T06:01:01.955Z","updated_at":"2026-04-02T06:01:01.955Z","repository_link":"https://github.com/fluxopt/fluxopt/blob/main/pyproject.toml","dependencies":[{"id":25852183165,"package_name":"highspy","ecosystem":"pypi","requirements":"\u003e=1.13.1","direct":true,"kind":"runtime","optional":false},{"id":25852183177,"package_name":"linopy","ecosystem":"pypi","requirements":"@ git+https://github.com/PyPSA/linopy.git@f53d1968e53d70962eb208b01c3f938f693f0083","direct":true,"kind":"runtime","optional":false},{"id":25852183345,"package_name":"netcdf4","ecosystem":"pypi","requirements":"\u003e=1.6.0","direct":true,"kind":"runtime","optional":false},{"id":25852183350,"package_name":"numpy","ecosystem":"pypi","requirements":"\u003e=1.26","direct":true,"kind":"runtime","optional":false},{"id":25852183351,"package_name":"pandas","ecosystem":"pypi","requirements":"\u003e=2.1","direct":true,"kind":"runtime","optional":false},{"id":25852183352,"package_name":"xarray","ecosystem":"pypi","requirements":"\u003e=2024.1.0","direct":true,"kind":"runtime","optional":false}]},{"ecosystem":"actions","filepath":".github/workflows/dependabot-auto-merge.yaml","sha":null,"kind":"manifest","created_at":"2026-04-02T06:01:01.739Z","updated_at":"2026-04-02T06:01:01.739Z","repository_link":"https://github.com/fluxopt/fluxopt/blob/main/.github/workflows/dependabot-auto-merge.yaml","dependencies":[{"id":25852183142,"package_name":"dependabot/fetch-metadata","ecosystem":"actions","requirements":"v2","direct":true,"kind":"composite","optional":false},{"id":25852183143,"package_name":"actions/create-github-app-token","ecosystem":"actions","requirements":"v3","direct":true,"kind":"composite","optional":false}]},{"ecosystem":"actions","filepath":".github/workflows/ci.yaml","sha":null,"kind":"manifest","created_at":"2026-04-02T06:01:01.491Z","updated_at":"2026-04-02T06:01:01.491Z","repository_link":"https://github.com/fluxopt/fluxopt/blob/main/.github/workflows/ci.yaml","dependencies":[{"id":25852183128,"package_name":"actions/checkout","ecosystem":"actions","requirements":"v6","direct":true,"kind":"composite","optional":false},{"id":25852183129,"package_name":"astral-sh/ruff-action","ecosystem":"actions","requirements":"v3","direct":true,"kind":"composite","optional":false},{"id":25852183136,"package_name":"astral-sh/setup-uv","ecosystem":"actions","requirements":"v7","direct":true,"kind":"composite","optional":false},{"id":25852183137,"package_name":"actions/setup-python","ecosystem":"actions","requirements":"v6","direct":true,"kind":"composite","optional":false},{"id":25852183141,"package_name":"codecov/codecov-action","ecosystem":"actions","requirements":"v5","direct":true,"kind":"composite","optional":false}]},{"ecosystem":"actions","filepath":".github/workflows/pr-title.yaml","sha":null,"kind":"manifest","created_at":"2026-04-02T06:01:01.791Z","updated_at":"2026-04-02T06:01:01.791Z","repository_link":"https://github.com/fluxopt/fluxopt/blob/main/.github/workflows/pr-title.yaml","dependencies":[{"id":25852183145,"package_name":"amannn/action-semantic-pull-request","ecosystem":"actions","requirements":"v6","direct":true,"kind":"composite","optional":false}]},{"ecosystem":"actions","filepath":".github/workflows/release.yaml","sha":null,"kind":"manifest","created_at":"2026-04-02T06:01:01.904Z","updated_at":"2026-04-02T06:01:01.904Z","repository_link":"https://github.com/fluxopt/fluxopt/blob/main/.github/workflows/release.yaml","dependencies":[{"id":25852183157,"package_name":"actions/create-github-app-token","ecosystem":"actions","requirements":"v3","direct":true,"kind":"composite","optional":false},{"id":25852183158,"package_name":"googleapis/release-please-action","ecosystem":"actions","requirements":"v4","direct":true,"kind":"composite","optional":false}]},{"ecosystem":"actions","filepath":".github/workflows/publish.yaml","sha":null,"kind":"manifest","created_at":"2026-04-02T06:01:01.851Z","updated_at":"2026-04-02T06:01:01.851Z","repository_link":"https://github.com/fluxopt/fluxopt/blob/main/.github/workflows/publish.yaml","dependencies":[{"id":25852183149,"package_name":"actions/checkout","ecosystem":"actions","requirements":"v6","direct":true,"kind":"composite","optional":false},{"id":25852183150,"package_name":"astral-sh/setup-uv","ecosystem":"actions","requirements":"v7","direct":true,"kind":"composite","optional":false},{"id":25852183151,"package_name":"actions/setup-python","ecosystem":"actions","requirements":"v6","direct":true,"kind":"composite","optional":false},{"id":25852183152,"package_name":"pypa/gh-action-pypi-publish","ecosystem":"actions","requirements":"release/v1","direct":true,"kind":"composite","optional":false}]},{"ecosystem":"actions","filepath":".github/workflows/label-from-title.yaml","sha":null,"kind":"manifest","created_at":"2026-05-05T10:00:31.852Z","updated_at":"2026-05-05T10:00:31.852Z","repository_link":"https://github.com/fluxopt/fluxopt/blob/main/.github/workflows/label-from-title.yaml","dependencies":[]}],"score":null,"created_at":"2026-06-14T00:04:46.824Z","updated_at":"2026-06-19T00:30:44.100Z","avatar_url":"https://github.com/fluxopt.png","language":"Python","category":"Energy Systems","sub_category":"Energy System Modeling Frameworks","monthly_downloads":0,"total_dependent_repos":0,"total_dependent_packages":0,"readme":"# fluxopt\n\nEnergy system optimization with [linopy](https://github.com/PyPSA/linopy) — detailed dispatch, scaled to multi period planning.\n\n[![PyPI](https://img.shields.io/pypi/v/fluxopt)](https://pypi.org/project/fluxopt/)\n[![Downloads](https://img.shields.io/pypi/dm/fluxopt)](https://pypi.org/project/fluxopt/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)\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\n\u003e **Early development** — the API may change between releases.\n\u003e Planned features and progress are tracked in [Issues](https://github.com/FBumann/fluxopt/issues).\n\n## Installation\n\n```bash\npip install fluxopt\n```\n\nIncludes the [HiGHS](https://highs.dev/) solver out of the box.\n\n## Quick Start\n\n\u003c!--quickstart-start--\u003e\n```python\n# A gas boiler covers a heat demand, minimizing fuel cost\nfrom datetime import datetime\nfrom fluxopt import Carrier, Converter, Effect, Flow, Port, optimize\n\nresult = optimize(\n    timesteps=[datetime(2024, 1, 1, h) for h in range(4)],\n    carriers=[Carrier('gas'), Carrier('heat')],\n    effects=[Effect('cost')],\n    ports=[\n        Port('grid', imports=[\n            Flow('gas', size=500, effects_per_flow_hour={'cost': 0.04})\n        ]),\n        Port('demand', exports=[\n            Flow('heat', size=100, fixed_relative_profile=[0.4, 0.7, 0.5, 0.6])\n        ])\n    ],\n    converters=[\n        Converter.boiler(\n            'boiler',\n            thermal_efficiency=0.9,\n            fuel_flow=Flow('gas', size=300),\n            thermal_flow=Flow('heat', size=200)\n        )\n    ],\n    objective_effects='cost',\n)\n\nprint(f\"Total cost: {result.objective:.2f}\")\nprint(result.flow_rates)\n```\n\u003c!--quickstart-end--\u003e\n\n## Roadmap\n\nfluxopt is evolving into a family of packages with a lean core and optional companions:\n\n```\n                          ┌──────────────┐\n                          │   fluxopt    │  core: model building, solving, results, IO\n                          └──────┬───────┘\n        ┌──────────────┬─────────┼──────────────┬──────────────┐\n        │              │         │              │              │\n fluxopt-plot   fluxopt-yaml  fluxopt-tsam  fluxopt-marimo  (examples)\n   plotting      YAML+CSV    time series    interactive     cross-package\n   (plotly)       loader     aggregation       apps          notebooks\n```\n\nCompanion packages depend on core — core has no knowledge of companions.\n\n### Companion packages\n\n| Package | Role | Versioning · Tier | `fluxopt` pin | Status |\n|---------|------|-------------------|---------------|--------|\n| `fluxopt-plot` | Result visualization (Plotly) | Semver · Experimental — method signatures may change | Tight (`\u003e=A.B,\u003cA.C`), validated per release | Scaffolded — [docs](https://fbumann.github.io/fluxopt-plot/latest/) · [#51](https://github.com/FBumann/fluxopt/issues/51) |\n| `fluxopt-yaml` | Declarative model loader (YAML + CSV → `Element`s) | Semver · Experimental — YAML schema may change | Tight (`\u003e=A.B,\u003cA.C`), validated per release | Scaffolded — [docs](https://fbumann.github.io/fluxopt-yaml/latest/) · [#52](https://github.com/FBumann/fluxopt/issues/52) |\n| `fluxopt-tsam` | Time series aggregation — input pre-processing, possibly result disaggregation | Semver · Experimental — round-trip schema may evolve | **Undecided** — depends on whether representative-period primitives live in core (→ loose) or in this package (→ tight) | Planned |\n| `fluxopt-marimo` | Interactive exploration \u0026 dashboards (marimo apps) | CalVer (`YYYY.MM.PATCH`) · Experimental — apps are templates | Tight (`\u003e=A.B,\u003cA.C`), validated per release | Planned |\n\nTight-pinned companions release on every `fluxopt` minor; validation is\nautomated via scheduled CI. `fluxopt-tsam`'s pin policy is blocked on an\narchitectural decision — if representative-period primitives live in core, tsam stays\na thin adapter (loose pin); if they live in tsam, the package owns deep\nround-trip behavior (tight pin).\n\n### Milestones\n\nCross-cutting work not tied to a single companion package:\n\n| Milestone | Description | Status | Issue |\n|-----------|-------------|--------|-------|\n| `Result.stats` accessor | Cached xarray properties for post-processing | Planned | [#49](https://github.com/FBumann/fluxopt/issues/49) |\n| `.plot` stub on `Result` | Discoverable property, helpful error if plot package absent | Planned | [#50](https://github.com/FBumann/fluxopt/issues/50) |\n| ReadTheDocs migration | Automatic versioned docs from git tags | Planned | [#53](https://github.com/FBumann/fluxopt/issues/53) |\n| Remove plotly from core | Keep core lean — plotting deps in `fluxopt-plot` only | Planned | [#54](https://github.com/FBumann/fluxopt/issues/54) |\n\n### Stability Tiers\n\n| Component | Tier | Policy |\n|-----------|------|--------|\n| Core modeling API | **Stable** | Semver. Deprecation warnings before removal. |\n| Stats accessor | **Semi-stable** | Breaking changes allowed between minor versions with changelog entry. |\n\nCompanion packages have their own stability policies — see the table above.\n\nSee [#47](https://github.com/FBumann/fluxopt/issues/47) for the full architecture discussion.\n\n## Development\n\nRequires [uv](https://docs.astral.sh/uv/) and Python \u003e= 3.12.\n\n```bash\nuv sync --group dev      # Install deps\nuv run pytest -v         # Run tests\nuv run ruff check .      # Lint\nuv run ruff format .     # Format\n```\n\n## License\n\nMIT\n","funding_links":[],"readme_doi_urls":[],"works":{},"citation_counts":{},"total_citations":0,"keywords_from_contributors":[],"project_url":"https://ost.ecosyste.ms/api/v1/projects/357992","html_url":"https://ost.ecosyste.ms/projects/357992"}