[](https://gitter.im/calliope-project/calliope)
[](https://dev.azure.com/calliope-project/calliope/_build?definitionId=1)
[](https://readthedocs.org/projects/calliope/builds/)
[](https://codecov.io/gh/calliope-project/calliope)
[](https://pypi.python.org/pypi/calliope)
[](https://anaconda.org/conda-forge/calliope)
[](https://doi.org/10.21105/joss.00825)
---
<img src="https://raw.githubusercontent.com/calliope-project/calliope/master/doc/_static/logo.png" width="364">
*A multi-scale energy systems modelling framework* | [www.callio.pe](http://www.callio.pe/)
---
## Contents
- [Contents](#contents)
- [About](#about)
- [Quick start](#quick-start)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [What's new](#whats-new)
- [Citing Calliope](#citing-calliope)
- [License](#license)
---
## 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). 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](http://pandas.pydata.org/) and [xarray](http://xarray.pydata.org/).
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 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 calliope`.
See the documentation for more [information on installing](https://calliope.readthedocs.io/en/stable/user/installation.html), including what to do if you are having issues with `conda`.
Several easy to understand example models are [included with Calliope](calliope/example_models) and accessible through the `calliope.examples` submodule.
The [tutorials in the documentation run through these examples](https://calliope.readthedocs.io/en/stable/user/tutorials.html). 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 our [model gallery](https://www.callio.pe/model-gallery/).
## Documentation
Documentation is available on Read the Docs:
* [Read the documentation online (recommended)](https://calliope.readthedocs.io/en/stable/)
* [Download all documentation in a single PDF file](https://readthedocs.org/projects/calliope/downloads/pdf/stable/)
## 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](https://github.com/calliope-project/calliope/blob/master/CONTRIBUTING.md) for more information -- and [join us on Gitter](https://gitter.im/calliope-project/calliope) to ask questions or discuss code.
## What's new
See changes made in recent versions in the [changelog](https://github.com/calliope-project/calliope/blob/master/changelog.rst).
## Citing Calliope
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](https://doi.org/10.21105/joss.00825)
## License
Copyright since 2013 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.
Raw data
{
"_id": null,
"home_page": "https://www.callio.pe/",
"name": "calliope",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "energy systems,optimisation,mathematical programming",
"author": "Calliope contributors listed in AUTHORS",
"author_email": "stefan@pfenninger.org",
"download_url": "https://files.pythonhosted.org/packages/94/e6/2a146f5a40c0761bcacba273d88dea48b3742d3c8e765d95ce2ff29eca51/calliope-0.6.10.tar.gz",
"platform": null,
"description": "[](https://gitter.im/calliope-project/calliope)\n[](https://dev.azure.com/calliope-project/calliope/_build?definitionId=1)\n[](https://readthedocs.org/projects/calliope/builds/)\n[](https://codecov.io/gh/calliope-project/calliope)\n[](https://pypi.python.org/pypi/calliope)\n[](https://anaconda.org/conda-forge/calliope)\n[](https://doi.org/10.21105/joss.00825)\n\n---\n\n<img src=\"https://raw.githubusercontent.com/calliope-project/calliope/master/doc/_static/logo.png\" width=\"364\">\n\n*A multi-scale energy systems modelling framework* | [www.callio.pe](http://www.callio.pe/)\n\n---\n\n## Contents\n\n- [Contents](#contents)\n- [About](#about)\n- [Quick start](#quick-start)\n- [Documentation](#documentation)\n- [Contributing](#contributing)\n- [What's new](#whats-new)\n- [Citing Calliope](#citing-calliope)\n- [License](#license)\n\n---\n\n## About\n\nCalliope 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.\n\nA 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](http://pandas.pydata.org/) and [xarray](http://xarray.pydata.org/).\n\nCalliope 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.\n\n## Quick start\n\nCalliope 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 calliope`.\n\nSee the documentation for more [information on installing](https://calliope.readthedocs.io/en/stable/user/installation.html), including what to do if you are having issues with `conda`.\n\nSeveral easy to understand example models are [included with Calliope](calliope/example_models) and accessible through the `calliope.examples` submodule.\n\nThe [tutorials in the documentation run through these examples](https://calliope.readthedocs.io/en/stable/user/tutorials.html). 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.\n\nMore fully-featured examples that have been used in peer-reviewed scientific publications are available in our [model gallery](https://www.callio.pe/model-gallery/).\n\n## Documentation\n\nDocumentation is available on Read the Docs:\n\n* [Read the documentation online (recommended)](https://calliope.readthedocs.io/en/stable/)\n* [Download all documentation in a single PDF file](https://readthedocs.org/projects/calliope/downloads/pdf/stable/)\n\n## Contributing\n\nTo contribute changes:\n\n1. Fork the project on GitHub\n2. Create a feature branch to work on in your fork (`git checkout -b new-feature`)\n3. Add your name to the AUTHORS file\n4. Commit your changes to the feature branch\n5. Push the branch to GitHub (`git push origin my-new-feature`)\n6. On GitHub, create a new pull request from the feature branch\n\nSee our [contribution guidelines](https://github.com/calliope-project/calliope/blob/master/CONTRIBUTING.md) for more information -- and [join us on Gitter](https://gitter.im/calliope-project/calliope) to ask questions or discuss code.\n\n## What's new\n\nSee changes made in recent versions in the [changelog](https://github.com/calliope-project/calliope/blob/master/changelog.rst).\n\n## Citing Calliope\n\nIf you use Calliope for academic work please cite:\n\nStefan 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](https://doi.org/10.21105/joss.00825)\n\n## License\n\nCopyright since 2013 Calliope contributors listed in AUTHORS\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you\nmay not use this file except in compliance with the License. You may\nobtain a copy of the License at\n\n<http://www.apache.org/licenses/LICENSE-2.0>\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A multi-scale energy systems modelling framework",
"version": "0.6.10",
"project_urls": {
"Download": "https://github.com/calliope-project/calliope/releases",
"Homepage": "https://www.callio.pe/"
},
"split_keywords": [
"energy systems",
"optimisation",
"mathematical programming"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94e62a146f5a40c0761bcacba273d88dea48b3742d3c8e765d95ce2ff29eca51",
"md5": "ea8f87e186948ef0aad8c9a1f6bca847",
"sha256": "1a9d29e63063b9d0f8256337d5f8a5d08c3ba1319fc6e72f37448111676c1ee9"
},
"downloads": -1,
"filename": "calliope-0.6.10.tar.gz",
"has_sig": false,
"md5_digest": "ea8f87e186948ef0aad8c9a1f6bca847",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 727503,
"upload_time": "2023-01-18T15:55:57",
"upload_time_iso_8601": "2023-01-18T15:55:57.833670Z",
"url": "https://files.pythonhosted.org/packages/94/e6/2a146f5a40c0761bcacba273d88dea48b3742d3c8e765d95ce2ff29eca51/calliope-0.6.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-18 15:55:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "calliope-project",
"github_project": "calliope",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "calliope"
}
JSON
