timtroendle / calliope Goto Github PK

A multi-scale energy systems modelling 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). 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.

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.

Documentation is available on Read the Docs:

• Read the documentation online (recommended)
• Download all documentation in a single PDF file

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.

See changes made in recent versions in the changelog.

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

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.