A multi-scale energy systems modelling framework
Clone or download
timtroendle and sjpfenninger Fix resource area max default (#160)
Default was ``False`` with the intention to deactivate the constraint. Quite the opposite actually happened: ``False`` was evaluated to ``0`` _activating_ this constraint to its maximum.

Now the default is ``inf`` which will actually deactivate the constraint (in compliance with other upper bound constraints).

In the documentation, resource areas were related to collector areas. But these constraints can equally be used for all sorts of other technologies with area restrictions.Hence, I made the documentation slightly more generic.
Latest commit 8f08075 Oct 26, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update pull request template Apr 27, 2018
calliope Fix resource area max default (#160) Oct 26, 2018
doc Fix documentation on amendments of abstract base tech groups (#158) Oct 26, 2018
paper JOSS paper: fix bibliography, bump to 0.6.2 Sep 11, 2018
requirements Clean up versions Oct 5, 2018
utils Add conda_create util; test Py 3.5/3.6 but not 3.7 (#154) Oct 10, 2018
.appveyor.yml Add conda_create util; test Py 3.5/3.6 but not 3.7 (#154) Oct 10, 2018
.coveragerc Updates to base constraints and other fixes Nov 4, 2014
.flake8 Add hound and flake8 config; minor cleanup Jun 12, 2017
.gitattributes Update author statements and citation info Apr 4, 2017
.gitignore Add function plot_flows (#123) Aug 16, 2018
.hound.yml Add more constraints and clean up aux files Jan 17, 2018
.pylintrc Add more constraints and clean up aux files Jan 17, 2018
.readthedocs.yml Clean up aux files Apr 6, 2018
.travis.yml Add conda_create util; test Py 3.5/3.6 but not 3.7 (#154) Oct 10, 2018
AUTHORS Add function plot_flows (#123) Aug 16, 2018
CITATION Update citation and README for accepted JOSS paper Sep 13, 2018
CODE_OF_CONDUCT.md Add help for contributors Mar 9, 2018
CONTRIBUTING.md Clean up AUTHORS and contribution licensing info Apr 30, 2018
LICENSE Apache 2.0 license Jan 2, 2014
MANIFEST.in Clean up aux files Apr 6, 2018
Makefile New scenarios and overrides (#145) Oct 2, 2018
README.rst Clean up docs Oct 3, 2018
changelog.rst Fix resource area max default (#160) Oct 26, 2018
make.bat New scenarios and overrides (#145) Oct 2, 2018
setup.py Clean up versions Oct 5, 2018


Chat on Gitter Build status on Linux Build status on Windows Documentation build status Test coverage PyPI version Anaconda.org/conda-forge version JOSS DOI


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

1   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 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.

Calliope comes with several built-in analysis and visualisation tools. Having some knowledge of the Python programming language helps when running Calliope and using these tools, but is not a prerequisite.

2   Quick start

Calliope can run on Windows, macOS and Linux. Installing it is quickest with the conda package manager by running a single command: conda create -c conda-forge -n calliope python=3.6 calliope. 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 "Introduction", "Building a model", "Running a model", and "Analysing a model" sections in the online documentation.

A fully-featured example model is UK-Calliope, which models the power system of Great Britain (England+Scotland+Wales), and has been used in several peer-reviewed scientific publications.

3   Documentation

Documentation is available on Read the Docs:

4   Contributing

To contribute changes:

  1. Fork the project on GitHub
  2. Create a feature branch to work on in your fork (git checkout -b new-feature)
  3. Add your name to the AUTHORS file
  4. Commit your changes to the feature branch
  5. Push the branch to GitHub (git push origin my-new-feature)
  6. On GitHub, create a new pull request from the feature branch

See our contribution guidelines for more information -- and join us on Gitter to ask questions or discuss code.

5   What's new

See changes made in recent versions in the changelog.

6   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

7   License

Copyright 2013-2018 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


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.