Package: calliope
A multi-scale energy systems modelling framework|www.callio.peContentsContentsAboutQuick startDocumentationContributingWhat's newCiting CalliopeLicenseAboutCalliope 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 likePandasandxarray.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.Quick startCalliope can run on Windows, macOS and Linux. Installing it is quickest with thecondapackage manager by running a single command:conda create -c conda-forge -n calliope calliope.See the documentation for moreinformation on installing, including what to do if you are having issues withconda.Several easy to understand example models areincluded with Calliopeand accessible through thecalliope.examplessubmodule.Thetutorials 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.More fully-featured examples that have been used in peer-reviewed scientific publications are available in ourmodel gallery.DocumentationDocumentation is available on Read the Docs:Read the documentation online (recommended)Download all documentation in a single PDF fileContributingTo contribute changes:Fork the project on GitHubCreate a feature branch to work on in your fork (git checkout -b new-feature)Add your name to the AUTHORS fileCommit your changes to the feature branchPush the branch to GitHub (git push origin my-new-feature)On GitHub, create a new pull request from the feature branchSee ourcontribution guidelinesfor more information -- andjoin us on Gitterto ask questions or discuss code.What's newSee changes made in recent versions in thechangelog.Citing CalliopeIf 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.00825LicenseCopyright since 2013 Calliope contributors listed in AUTHORSLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.