Calliope Studio
Calliope Studio is a web-based user interface for the Calliope energy system modelling framework.
It lets you define, edit, validate, run, and analyse Calliope models, all in a single tool.
It runs in a browser directly on your computer.
Installation
With uv:
# One-time setup for uv on macOS and Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
# One-time setup for uv on Windows
# powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
uv tool install calliope-studio
Then:
calliope-studio my-model # a model folder containing model.yaml or a solved results .nc
calliope-studio # no argument opens Calliope Studio with a model picker
To quit Calliope Studio, close its terminal window or press Ctrl+C inside it.
[!IMPORTANT] Calliope needs a solver to actually solve models. You can still use Studio to edit a model or analyse results that somebody else solved, but pressing Run will fail without a solver. Refer to the Calliope documentation for solver installation.
FAQ
- Why does "Run" fail with a solver error? See the note above: you probably have no solver installed.
- Why is the list of models wrong or outdated? The list of models you have opened lives in a small registry file, separate from the models themselves. Its location is reported as
registry_pathbyhttp://127.0.0.1:8000/api/healthwhile Calliope Studio is running. Deleting it resets the list without actually touching any of your models. - Where are model results stored? When running a model from inside Calliope Studio, results are saved in a
calliope-studio/folder next to themodel.yamlfile. This folder is created automatically when running a model for the first time and comes with its own.gitignorefile.
Development
Requires pixi.
pixi run serve # API on port 8000 with auto-reload
pixi run web-dev # Vite dev server, proxying /api to port 8000
serve opens ./example-model, scaffolding it from Calliope's national_scale template on first use.
Try pixi task list to see all the available development tasks. Some relevant ones:
pixi run solve-examplessolves both Calliope example models intoexamples/nc_files/. The data tests and the results smoke check read these files, and skip when they are absent.pixi run testruns the Python test suite.pixi run -e build buildproduces a wheel and an sdist with the frontend compiled in (the packaging tools live in thebuildenvironment).
The frontend tests run from web/:
cd web
pnpm test
Pixi is configured with a gurobi environment to test with Gurobi (needs a license):
pixi run -e gurobi calliope-studio my-model # Gurobi available as a solver
License
AGPL-3.0-or-later. See LICENSE.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file calliope_studio-0.1.0.tar.gz.
File metadata
- Download URL: calliope_studio-0.1.0.tar.gz
- Upload date:
- Size: 4.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b595650b55648839bb4efc9c7243eacfa131120726f0e41dfa08b7dc7d28ec7
|
|
| MD5 |
79a36a04e911c9889f1093249b4c9a69
|
|
| BLAKE2b-256 |
cf3a1d9303ed3dedb60a3be5621f5b536dc3504bedb9db07069a9e461ef375a6
|
Provenance
The following attestation bundles were made for calliope_studio-0.1.0.tar.gz:
Publisher:
release.yml on sjpfenninger/calliope-studio
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
calliope_studio-0.1.0.tar.gz -
Subject digest:
7b595650b55648839bb4efc9c7243eacfa131120726f0e41dfa08b7dc7d28ec7 - Sigstore transparency entry: 2614930681
- Sigstore integration time:
-
Permalink:
sjpfenninger/calliope-studio@23e5ab168cbb6baaecab30d69e685d9b0801035e -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/sjpfenninger
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@23e5ab168cbb6baaecab30d69e685d9b0801035e -
Trigger Event:
push
-
Statement type:
File details
Details for the file calliope_studio-0.1.0-py3-none-any.whl.
File metadata
- Download URL: calliope_studio-0.1.0-py3-none-any.whl
- Upload date:
- Size: 4.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5baa3b0a93684b0321e5c68126a9010895397cd685bf4de12bf5213c304b9748
|
|
| MD5 |
fb3879e9e98f2fcef1d5b80e5703ee95
|
|
| BLAKE2b-256 |
81cc0d0736816b39d342fc01a9bbd8ea15422c91ef1c6f193a1c24275ee50f7d
|
Provenance
The following attestation bundles were made for calliope_studio-0.1.0-py3-none-any.whl:
Publisher:
release.yml on sjpfenninger/calliope-studio
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
calliope_studio-0.1.0-py3-none-any.whl -
Subject digest:
5baa3b0a93684b0321e5c68126a9010895397cd685bf4de12bf5213c304b9748 - Sigstore transparency entry: 2614931103
- Sigstore integration time:
-
Permalink:
sjpfenninger/calliope-studio@23e5ab168cbb6baaecab30d69e685d9b0801035e -
Branch / Tag:
refs/tags/v0.1.0 - Owner: https://github.com/sjpfenninger
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@23e5ab168cbb6baaecab30d69e685d9b0801035e -
Trigger Event:
push
-
Statement type:
