Calliope
Calliope: a multi-scale energy systems modelling framework - Published in JOSS (2018)
Science Score: 100.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 7 DOI reference(s) in README and JOSS metadata -
○Academic publication links
-
✓Committers with academic emails
5 of 23 committers (21.7%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Keywords from Contributors
Repository
A multi-scale energy systems modelling framework
Basic Info
- Host: GitHub
- Owner: calliope-project
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://www.callio.pe
- Size: 64 MB
Statistics
- Stars: 334
- Watchers: 16
- Forks: 99
- Open Issues: 63
- Releases: 29
Topics
Metadata Files
README.md
A multi-scale energy systems modelling framework | www.callio.pe
Contents
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 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.
Quick start
Calliope can run on Windows, macOS and Linux. Installing it is quickest with the mamba package manager by running a single command: mamba create -n calliope -c conda-forge conda-forge/label/calliope_dev::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.
More fully-featured examples that have been used in peer-reviewed scientific publications are available in our model gallery.
Documentation
Documentation is available on Read the Docs.
Contributing
See our documentation for more on how to contribute to Calliope.
What's new
See changes made in recent versions in the changelog.
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
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.
Owner
- Name: Calliope
- Login: calliope-project
- Kind: organization
- Website: https://www.callio.pe/
- Repositories: 14
- Profile: https://github.com/calliope-project
A multi-scale energy systems modelling framework
JOSS Publication
Calliope: a multi-scale energy systems modelling framework
Authors
Department of Environmental Systems Science, ETH Zürich
Department of Engineering, University of Cambridge
Editor
Jed Brown
Tags
energy optimisation pythonCitation (CITATION)
Stefan Pfenninger and Bryn Pickering (2018). Calliope: a multi-scale energy systems modelling framework. Journal of Open Source Software, 3(29), 825. https://doi.org/10.21105/joss.00825
GitHub Events
Total
- Create event: 50
- Release event: 2
- Issues event: 86
- Watch event: 33
- Delete event: 44
- Issue comment event: 234
- Push event: 251
- Pull request review comment event: 294
- Pull request review event: 336
- Pull request event: 81
- Fork event: 11
Last Year
- Create event: 51
- Release event: 2
- Issues event: 86
- Watch event: 33
- Delete event: 44
- Issue comment event: 236
- Push event: 254
- Pull request review comment event: 294
- Pull request review event: 336
- Pull request event: 81
- Fork event: 11
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Stefan Pfenninger | s****n@p****g | 756 |
| brynpickering | b****g@g****m | 378 |
| brynpickering | b****g@u****h | 53 |
| Tim Tröndle | t****e@u****h | 20 |
| pre-commit-ci[bot] | 6****] | 15 |
| Ivan Ruiz Manuel | 7****e | 11 |
| Francesco Lombardi | f****i@p****t | 4 |
| Bryn Pickering | b****g@u****h | 4 |
| Francesco Lombardi | f****i@o****m | 4 |
| jnnr | 3****r | 4 |
| graeme | g****e@l****m | 3 |
| Adriaan Hilbers | 3****s | 2 |
| Francesco Sanvito | 6****t | 2 |
| Suvayu Ali | f****x@g****m | 2 |
| Graeme Hawker | g****r@s****k | 1 |
| Katrin Leinweber | k****i@p****e | 1 |
| Martial G | m****y@g****m | 1 |
| Stefan Strömer | 8****r | 1 |
| brmanuel | m****n@h****m | 1 |
| Stefan Pfenninger | s****n@u****h | 1 |
| dependabot[bot] | 4****] | 1 |
| omahs | 7****s | 1 |
| pmmeyourmodel | 4****l | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 385
- Total pull requests: 494
- Average time to close issues: 10 months
- Average time to close pull requests: 27 days
- Total issue authors: 61
- Total pull request authors: 21
- Average comments per issue: 2.12
- Average comments per pull request: 2.1
- Merged pull requests: 408
- Bot issues: 0
- Bot pull requests: 28
Past Year
- Issues: 65
- Pull requests: 108
- Average time to close issues: about 2 months
- Average time to close pull requests: 13 days
- Issue authors: 17
- Pull request authors: 9
- Average comments per issue: 1.11
- Average comments per pull request: 1.93
- Merged pull requests: 70
- Bot issues: 0
- Bot pull requests: 20
Top Authors
Issue Authors
- brynpickering (103)
- sjpfenninger (61)
- irm-codebase (43)
- timtroendle (38)
- FLomb (19)
- arnaud-leroy (13)
- jmorrisnrel (12)
- jnnr (8)
- sstroemer (8)
- lblabr (4)
- mohammadamint (4)
- CROdominik (3)
- fvandebeek (3)
- ahilbers (3)
- yiqiaowang-arch (3)
Pull Request Authors
- brynpickering (291)
- sjpfenninger (59)
- irm-codebase (47)
- pre-commit-ci[bot] (26)
- timtroendle (21)
- FLomb (14)
- jnnr (7)
- ahilbers (4)
- GraemeHawker (4)
- sstroemer (3)
- FraSanvit (3)
- suvayu (3)
- omahs (2)
- dependabot[bot] (2)
- leopardracer (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 268 last-month
-
Total dependent packages: 2
(may contain duplicates) -
Total dependent repositories: 5
(may contain duplicates) - Total versions: 79
- Total maintainers: 2
proxy.golang.org: github.com/calliope-project/calliope
- Documentation: https://pkg.go.dev/github.com/calliope-project/calliope#section-documentation
- License: apache-2.0
-
Latest release: v0.6.10
published almost 3 years ago
Rankings
pypi.org: calliope
A multi-scale energy systems modelling framework
- Homepage: https://www.callio.pe/
- Documentation: https://calliope.readthedocs.io/
- License: Apache 2.0
-
Latest release: 0.6.10
published almost 3 years ago
Rankings
Maintainers (2)
conda-forge.org: calliope
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).
- Homepage: https://www.callio.pe/
- License: Apache-2.0
-
Latest release: 0.6.8
published almost 4 years ago
Rankings
Dependencies
- actions/checkout v3 composite
- codecov/codecov-action v3 composite
- mamba-org/setup-micromamba v1 composite
- actions/checkout v3 composite
- gaurav-nelson/github-action-markdown-link-check 1.0.15 composite
- actions/checkout v3 composite
- codecov/codecov-action v3 composite
- mamba-org/setup-micromamba v1 composite
- bottleneck >=1,<2
- click >=8,<9
- geographiclib >=2,<3
- hdf5 <2
- ipdb >=0.13,<0.14
- ipykernel <7
- jinja2 >=3,<4
- jsonschema >=4,<5
- libnetcdf <5
- natsort >=8,<9
- netcdf4 >=1.2,<1.7
- numpy >=1,<2
- pandas >=2.1.3,<2.2
- pyomo >=6.5,<7
- pyparsing >=3.0,<3.1
- ruamel.yaml >=0.17,<0.18
- xarray >=2023.10,<2024.3
- glpk ==5.0 development
- pre-commit <4 development
- pytest <8 development
- pytest-cov <5 development
- pytest-order <2 development
- pytest-xdist <4 development
- dawidd6/action-download-artifact v2 composite
- pypa/gh-action-pypi-publish release/v1 composite