Skip to main content

A multi-scale energy systems modelling framework

Project description

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


https://raw.githubusercontent.com/calliope-project/calliope/master/doc/_static/logo.png

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

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.

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, please cite the following paper:

Stefan Pfenninger (2017). Dealing with multiple decades of hourly wind and PV time series in energy models: a comparison of methods to reduce time resolution and the planning implications of inter-annual variability. Applied Energy. doi: 10.1016/j.apenergy.2017.03.051

All Calliope releases are archived on Zenodo, and can be referred to by the overall concept DOI 10.5281/zenodo.593292. Each version also has its own specific DOI listed on Zenodo.

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
calliope-0.6.2.tar.gz (671.5 kB) Copy SHA256 hash SHA256 Source None Jun 4, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page