Skip to main content

A multi-scale energy systems (MUSES) modeling framework

Project description

https://travis-ci.org/calliope-project/calliope.svg https://img.shields.io/coveralls/calliope-project/calliope.svg https://img.shields.io/pypi/l/calliope.svg https://img.shields.io/pypi/v/calliope.svg
  _____     _____
 / ___/__ _/ / (_)__  ___  ___
/ /__/ _ `/ / / / _ \/ _ \/ -_)
\___/\_,_/_/_/_/\___/ .__/\__/
                   /_/

Calliope

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

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). It is under active development (see the roadmap).

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 data structures for easy analysis with Calliope’s built-in tools or the standard Python data analysis stack.

A simple example model is included with Calliope.

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

Quick start

Calliope can be run from the command line:

$ calliope new example  # Create a copy of the 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  # A dict of DataFrames

Documentation

Documentation is available at docs.callio.pe:

DOI for the most recent stable version on Zenodo: badge_doi

License

Copyright 2013-2015 Stefan Pfenninger

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.

Source Distribution

calliope-0.3.5.tar.gz (448.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page