/calliope

High-resolution open-source energy modelling framework in Python

Primary LanguagePythonApache License 2.0Apache-2.0

Chat on Gitter Build status on Linux Build status on Windows Test coverage PyPI version Anaconda.org version badge_license


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

A multi-scale energy systems (MUSES) modeling framework | www.callio.pe



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 model based on Calliope consists of a collection of text files (in YAML and CSV formats) that define the technologies, locations and resource potentials. Calliope takes these files, constructs an optimization problem, solves it, and reports results in the form of Pandas and xarray data structures for easy analysis with Calliope's built-in tools or the standard Python data analysis stack.

Two simple example models are included with Calliope and accessible through the calliope.examples submodule.

A more elaborate example is UK-Calliope, which models the power system of Great Britain (England+Scotland+Wales).

Install Calliope and all dependencies with conda:

$ conda create -c conda-forge -n calliope python=3.6 calliope

Calliope can be run from the command line:

$ calliope new example  # Create a copy of the national-scale example model, in the `example` dir

$ calliope run example/run.yaml  # Run the model by pointing to its run configuration file

It can also be run interactively from a Python session:

import calliope
model = calliope.Model('path/to/run.yaml')
model.run()
solution = model.solution  # An xarray.Dataset

Documentation is available on Read the Docs:

See changelog.rst.

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.

Copyright 2013-2017 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.