Calliope

A framework to develop energy system models, with a focus on flexibility, high spatial and temporal resolution, the ability to execute many runs based on the same base model, and a clear separation of framework and model.
https://github.com/calliope-project/calliope

Category: Energy Systems
Sub Category: Energy System Modeling Frameworks

Keywords

energy energy-system optimisation pyomo python

Keywords from Contributors

renewable-energy calliope-models conda europe datapackage tabular-data charging-profiles charging-strategies demand electric-vehicles-mobility

Last synced: about 19 hours ago
JSON representation

Repository metadata

A multi-scale energy systems modelling framework

README.md

Zulip chat
Main branch build status
Documentation build status
Test coverage
PyPI version
Anaconda.org/conda-forge version
JOSS DOI


A multi-scale energy systems modelling framework | www.callio.pe


Contents


About

Calliope is a framework to develop energy system models, with a focus on flexibility, high spatial and temporal resolution, the ability to execute many runs based on the same base model, and a clear separation of framework (code) and model (data).
Its primary focus is on planning energy systems at scales ranging from urban districts to entire continents.
In an optional operational mode it can also test a pre-defined system under different operational conditions.

A Calliope model consists of a collection of text files (in YAML and CSV formats) that fully define a model, with details on technologies, locations, resource potentials, etc.
Calliope takes these files, constructs an optimization problem, solves it, and reports back results.
Results can be saved to CSV or NetCDF files for further processing, or analysed directly in Python through Python's extensive scientific data processing capabilities provided by libraries like Pandas and xarray.

Model results can be explored interactively with Calligraph, our companion visualisation tool.
Having some knowledge of the Python programming language helps when running Calliope, but is not a prerequisite.

Quick start

Calliope can run on Windows, macOS and Linux.
It can be installed using pixi (pixi add calliope), conda (conda install calliope), or uv (uv pip install calliope).
For local development, use pixi as described in the documentation.

See the documentation for more information on installing.

Several easy to understand example models are included with Calliope and accessible through the calliope.examples submodule.

The tutorials in the documentation run through these examples.
A good place to start is to look at these tutorials to get a feel for how Calliope works, and then to read the "Getting Started" pages in the online documentation.

More fully-featured examples that have been used in peer-reviewed scientific publications are available in our model gallery.

Documentation

Documentation is available on Read the Docs.

Contributing

See our documentation for more on how to contribute to Calliope.

What's new

See changes made in recent versions in the changelog.

Citing Calliope

If you use Calliope for academic work please cite:

Stefan Pfenninger and Bryn Pickering (2018).
Calliope: a multi-scale energy systems modelling framework. Journal of Open Source Software, 3(29), 825. doi: 10.21105/joss.00825

License

Copyright since 2013 Calliope contributors listed in AUTHORS

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and limitations under the License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification.
Contributions of any kind welcome!

Citation (CITATION)

Stefan Pfenninger and Bryn Pickering (2018). Calliope: a multi-scale energy systems modelling framework. Journal of Open Source Software, 3(29), 825. https://doi.org/10.21105/joss.00825

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 1 day ago

Total Commits: 1,317
Total Committers: 25
Avg Commits per committer: 52.68
Development Distribution Score (DDS): 0.418

Commits in past year: 50
Committers in past year: 7
Avg Commits per committer in past year: 7.143
Development Distribution Score (DDS) in past year: 0.5

Name Email Commits
Stefan Pfenninger s****n@p****g 766
brynpickering b****g@g****m 403
brynpickering b****g@u****h 53
pre-commit-ci[bot] 6****] 21
Tim Tröndle t****e@u****h 20
Ivan Ruiz Manuel 7****e 17
Francesco Lombardi f****i@o****m 5
Bryn Pickering b****g@u****h 4
Francesco Lombardi f****i@p****t 4
jnnr 3****r 4
graeme g****e@l****m 3
Adriaan Hilbers 3****s 2
Francesco Sanvito 6****t 2
Suvayu Ali f****x@g****m 2
Graeme Hawker g****r@s****k 1
Katrin Leinweber k****i@p****e 1
Marija Cveevska 9****a 1
Martial G m****y@g****m 1
Sai Asish Y s****5@g****m 1
Stefan Strömer 8****r 1
Stefan Pfenninger s****n@u****h 1
brmanuel m****n@h****m 1
dependabot[bot] 4****] 1
omahs 7****s 1
pmmeyourmodel 4****l 1

Committer domains:


Issue and Pull Request metadata

Last synced: 3 days ago

Total issues: 402
Total pull requests: 545
Average time to close issues: 10 months
Average time to close pull requests: 27 days
Total issue authors: 65
Total pull request authors: 23
Average comments per issue: 2.13
Average comments per pull request: 1.99
Merged pull request: 445
Bot issues: 0
Bot pull requests: 32

Past year issues: 24
Past year pull requests: 63
Past year average time to close issues: about 1 month
Past year average time to close pull requests: 21 days
Past year issue authors: 12
Past year pull request authors: 7
Past year average comments per issue: 1.29
Past year average comments per pull request: 0.87
Past year merged pull request: 43
Past year bot issues: 0
Past year bot pull requests: 6

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/calliope-project/calliope

Top Issue Authors

  • brynpickering (104)
  • sjpfenninger (62)
  • irm-codebase (47)
  • timtroendle (38)
  • FLomb (20)
  • jmorrisnrel (15)
  • arnaud-leroy (13)
  • jnnr (8)
  • sstroemer (8)
  • ddahawkins-TUDelft (4)
  • lblabr (4)
  • mohammadamint (4)
  • yiqiaowang-arch (3)
  • ahilbers (3)
  • ramaroesilva (3)

Top Pull Request Authors

  • brynpickering (316)
  • sjpfenninger (69)
  • irm-codebase (55)
  • pre-commit-ci[bot] (30)
  • timtroendle (21)
  • FLomb (16)
  • jnnr (7)
  • ahilbers (4)
  • GraemeHawker (4)
  • sstroemer (3)
  • FraSanvit (3)
  • suvayu (3)
  • omahs (2)
  • dependabot[bot] (2)
  • leopardracer (2)

Top Issue Labels

  • bug (106)
  • documentation (64)
  • enhancement (48)
  • v0.7 (40)
  • discussion (20)
  • has-workaround (19)
  • priority (19)
  • v0.6 (16)
  • help wanted (14)
  • constraint (13)
  • good first issue (7)
  • wontfix (7)
  • possibly-revisit (7)
  • visualisation (5)
  • timeseries (3)
  • question (3)
  • duplicate (2)
  • pyomo-bug (1)

Top Pull Request Labels

  • v0.7 (13)
  • enhancement (4)
  • github_actions (2)
  • bug (2)
  • dependencies (2)

Package metadata

proxy.golang.org: github.com/calliope-project/calliope

pypi.org: calliope

A multi-scale energy systems modelling framework

  • Homepage: https://www.callio.pe/
  • Documentation: https://calliope.readthedocs.io/
  • Licenses: Apache 2.0
  • Latest release: 0.6.10 (published over 3 years ago)
  • Last Synced: 2026-08-12T05:31:09.901Z (1 day ago)
  • Versions: 33
  • Dependent Packages: 2
  • Dependent Repositories: 4
  • Downloads: 754 Last month
  • Rankings:
    • Dependent packages count: 3.155%
    • Dependent repos count: 7.506%
    • Average: 10.039%
    • Downloads: 19.458%
  • Maintainers (2)
conda-forge.org: calliope

Calliope is a framework to develop energy system models, with a focus on flexibility, high spatial and temporal resolution, the ability to execute many runs based on the same base model, and a clear separation of framework (code) and model (data).

  • Homepage: https://www.callio.pe/
  • Licenses: Apache-2.0
  • Latest release: 0.6.8 (published over 4 years ago)
  • Last Synced: 2026-07-22T19:18:18.685Z (22 days ago)
  • Versions: 17
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 289,767 Total
  • Rankings:
    • Forks count: 20.814%
    • Dependent repos count: 24.103%
    • Stargazers count: 25.685%
    • Average: 30.535%
    • Dependent packages count: 51.54%

Dependencies

.github/workflows/commit-ci.yml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 composite
  • mamba-org/setup-micromamba v1 composite
.github/workflows/link-check.yml actions
  • actions/checkout v3 composite
  • gaurav-nelson/github-action-markdown-link-check 1.0.15 composite
.github/workflows/pr-ci.yml actions
  • actions/checkout v3 composite
  • codecov/codecov-action v3 composite
  • mamba-org/setup-micromamba v1 composite
pyproject.toml pypi
requirements/base.txt pypi
  • bottleneck >=1,<2
  • click >=8,<9
  • geographiclib >=2,<3
  • hdf5 <2
  • ipdb >=0.13,<0.14
  • ipykernel <7
  • jinja2 >=3,<4
  • jsonschema >=4,<5
  • libnetcdf <5
  • natsort >=8,<9
  • netcdf4 >=1.2,<1.7
  • numpy >=1,<2
  • pandas >=2.1.3,<2.2
  • pyomo >=6.5,<7
  • pyparsing >=3.0,<3.1
  • ruamel.yaml >=0.17,<0.18
  • xarray >=2023.10,<2024.3
requirements/dev.txt pypi
  • glpk ==5.0 development
  • pre-commit <4 development
  • pytest <8 development
  • pytest-cov <5 development
  • pytest-order <2 development
  • pytest-xdist <4 development
.github/workflows/release.yml actions
  • dawidd6/action-download-artifact v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite

Score: 21.833819377558807