fluxopt
Energy system optimization with linopy — detailed dispatch, scaled to multi period planning.
https://github.com/fbumann/fluxopt
Last synced: 4 days ago
JSON representation
Acceptance Criteria
- Revelant topics? false
- External users? true
- Open source license? true
- Active? true
- Fork? false
Repository metadata
Successor of flixopt with a new datamodel
- Host: GitHub
- URL: https://github.com/fbumann/fluxopt
- Owner: FBumann
- License: mit
- Created: 2026-02-12T22:54:29.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-06-05T23:43:52.000Z (11 days ago)
- Last Synced: 2026-06-07T02:02:56.860Z (10 days ago)
- Language: Python
- Homepage: https://fluxopt.readthedocs.io/
- Size: 3.16 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 36
- Releases: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
README.md
fluxopt
Energy system optimization with linopy — detailed dispatch, scaled to multi period planning.
Early development — the API may change between releases.
Planned features and progress are tracked in Issues.
Installation
pip install fluxopt
Includes the HiGHS solver out of the box.
Quick Start
# A gas boiler covers a heat demand, minimizing fuel cost
from datetime import datetime
from fluxopt import Carrier, Converter, Effect, Flow, Port, optimize
result = optimize(
timesteps=[datetime(2024, 1, 1, h) for h in range(4)],
carriers=[Carrier('gas'), Carrier('heat')],
effects=[Effect('cost')],
ports=[
Port('grid', imports=[
Flow('gas', size=500, effects_per_flow_hour={'cost': 0.04})
]),
Port('demand', exports=[
Flow('heat', size=100, fixed_relative_profile=[0.4, 0.7, 0.5, 0.6])
])
],
converters=[
Converter.boiler(
'boiler',
thermal_efficiency=0.9,
fuel_flow=Flow('gas', size=300),
thermal_flow=Flow('heat', size=200)
)
],
objective_effects='cost',
)
print(f"Total cost: {result.objective:.2f}")
print(result.flow_rates)
Roadmap
fluxopt is evolving into a family of packages with a lean core and optional companions:
┌──────────────┐
│ fluxopt │ core: model building, solving, results, IO
└──────┬───────┘
┌──────────────┬─────────┼──────────────┬──────────────┐
│ │ │ │ │
fluxopt-plot fluxopt-yaml fluxopt-tsam fluxopt-marimo (examples)
plotting YAML+CSV time series interactive cross-package
(plotly) loader aggregation apps notebooks
Companion packages depend on core — core has no knowledge of companions.
Companion packages
| Package | Role | Versioning · Tier | fluxopt pin |
Status |
|---|---|---|---|---|
fluxopt-plot |
Result visualization (Plotly) | Semver · Experimental — method signatures may change | Tight (>=A.B,<A.C), validated per release |
Scaffolded — docs · #51 |
fluxopt-yaml |
Declarative model loader (YAML + CSV → Elements) |
Semver · Experimental — YAML schema may change | Tight (>=A.B,<A.C), validated per release |
Scaffolded — docs · #52 |
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 |
fluxopt-marimo |
Interactive exploration & dashboards (marimo apps) | CalVer (YYYY.MM.PATCH) · Experimental — apps are templates |
Tight (>=A.B,<A.C), validated per release |
Planned |
Tight-pinned companions release on every fluxopt minor; validation is
automated via scheduled CI. fluxopt-tsam's pin policy is blocked on an
architectural decision — if representative-period primitives live in core, tsam stays
a thin adapter (loose pin); if they live in tsam, the package owns deep
round-trip behavior (tight pin).
Milestones
Cross-cutting work not tied to a single companion package:
| Milestone | Description | Status | Issue |
|---|---|---|---|
Result.stats accessor |
Cached xarray properties for post-processing | Planned | #49 |
.plot stub on Result |
Discoverable property, helpful error if plot package absent | Planned | #50 |
| ReadTheDocs migration | Automatic versioned docs from git tags | Planned | #53 |
| Remove plotly from core | Keep core lean — plotting deps in fluxopt-plot only |
Planned | #54 |
Stability Tiers
| Component | Tier | Policy |
|---|---|---|
| Core modeling API | Stable | Semver. Deprecation warnings before removal. |
| Stats accessor | Semi-stable | Breaking changes allowed between minor versions with changelog entry. |
Companion packages have their own stability policies — see the table above.
See #47 for the full architecture discussion.
Development
Requires uv and Python >= 3.12.
uv sync --group dev # Install deps
uv run pytest -v # Run tests
uv run ruff check . # Lint
uv run ruff format . # Format
License
MIT
Owner metadata
- Name:
- Login: FBumann
- Email:
- Kind: user
- Description:
- Website:
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/117816358?v=4
- Repositories: 1
- Last ynced at: 2023-12-19T18:01:32.842Z
- Profile URL: https://github.com/FBumann
GitHub Events
Total
- Delete event: 16
- Pull request event: 45
- Issues event: 55
- Issue comment event: 33
- Push event: 157
- Pull request review comment event: 32
- Pull request review event: 18
- Create event: 46
Last Year
- Delete event: 16
- Pull request event: 45
- Issues event: 55
- Issue comment event: 33
- Push event: 157
- Pull request review comment event: 32
- Pull request review event: 18
- Create event: 46
Committers metadata
Last synced: 4 days ago
Total Commits: 125
Total Committers: 4
Avg Commits per committer: 31.25
Development Distribution Score (DDS): 0.176
Commits in past year: 125
Committers in past year: 4
Avg Commits per committer in past year: 31.25
Development Distribution Score (DDS) in past year: 0.176
| Name | Commits | |
|---|---|---|
| FBumann | 1****n | 103 |
| dependabot[bot] | 4****] | 15 |
| fluxopt-release[bot] | 2****] | 6 |
| GitButler | g****r@g****m | 1 |
Committer domains:
Issue and Pull Request metadata
Last synced: 4 days ago
Total issues: 13
Total pull requests: 33
Average time to close issues: about 6 hours
Average time to close pull requests: 6 days
Total issue authors: 1
Total pull request authors: 4
Average comments per issue: 0.15
Average comments per pull request: 1.42
Merged pull request: 15
Bot issues: 0
Bot pull requests: 17
Past year issues: 13
Past year pull requests: 33
Past year average time to close issues: about 6 hours
Past year average time to close pull requests: 6 days
Past year issue authors: 1
Past year pull request authors: 4
Past year average comments per issue: 0.15
Past year average comments per pull request: 1.42
Past year merged pull request: 15
Past year bot issues: 0
Past year bot pull requests: 17
Top Issue Authors
- FBumann (13)
Top Pull Request Authors
- FBumann (15)
- dependabot[bot] (15)
- fluxopt-release[bot] (2)
- Shaan-alpha (1)
Top Issue Labels
- type:feat (8)
- area:api (8)
- good first issue (4)
- area:io (3)
- type:docs (1)
- area:multi-period (1)
- area:new (1)
- area:storage (1)
Top Pull Request Labels
- dependencies (13)
- type:docs (7)
- autorelease: tagged (1)
- type:feat (1)
- type:fix (1)
- autorelease: pending (1)
Package metadata
- Total packages: 1
-
Total downloads:
- pypi: 383 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
- Total maintainers: 1
pypi.org: fluxopt
Energy system optimization with linopy — progressive modeling, from simple to complex.
- Homepage:
- Documentation: https://fluxopt.readthedocs.io/
- Licenses: MIT
- Latest release: 0.0.8 (published 16 days ago)
- Last Synced: 2026-06-11T04:00:39.478Z (6 days ago)
- Versions: 3
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 383 Last month
-
Rankings:
- Dependent packages count: 7.8%
- Average: 27.089%
- Downloads: 29.361%
- Dependent repos count: 44.106%
- Maintainers (1)
Dependencies
- highspy >=1.13.1
- linopy @ git+https://github.com/PyPSA/linopy.git@f53d1968e53d70962eb208b01c3f938f693f0083
- netcdf4 >=1.6.0
- numpy >=1.26
- pandas >=2.1
- xarray >=2024.1.0
- actions/create-github-app-token v3 composite
- dependabot/fetch-metadata v2 composite
- actions/checkout v6 composite
- actions/setup-python v6 composite
- astral-sh/ruff-action v3 composite
- astral-sh/setup-uv v7 composite
- codecov/codecov-action v5 composite
- amannn/action-semantic-pull-request v6 composite
- actions/create-github-app-token v3 composite
- googleapis/release-please-action v4 composite
- actions/checkout v6 composite
- actions/setup-python v6 composite
- astral-sh/setup-uv v7 composite
- pypa/gh-action-pypi-publish release/v1 composite
Score: 10.974523073434003