# Calligraph: Calliope model result graphing and visualisation tool
`Calligraph` is a tool to interactively explore and visualise Calliope model results.
> [!IMPORTANT]
> Note that this is pre-release software and there are likely to bugs. Please [report issues and feedback on GitHub](https://github.com/calliope-project/calligraph)!
> [!CAUTION]
> Calligraph only works with Calliope 0.7 or higher. If you are running Calliope 0.6 or lower, use the built-in visualisation tools instead.
## Installation
`pip install calligraph`
## Use
Save a solved Calliope model to a NetCDF file with `model.to_netcdf()` or by using the appropriate settings with the Calliope command-line interface. Then run `calligraph` in the command line:
```shell
$ calligraph your_model_results.nc
```
This launches Calligraph's web interface in the default web browser on your system. To use a custom port, supply the `--port PORTNUMBER` option; if you do not want the default web browser to open, specify `-nb` or `--no-browser`.
To experiment with the built-in urban-scale model:
```python
import calliope
m = calliope.examples.urban_scale(time_subset=None)
m.run()
m.to_netcdf("urban_scale.nc")
```
Then:
```shell
$ calligraph urban_scale.nc
```
Raw data
{
"_id": null,
"home_page": null,
"name": "calligraph",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Stefan Pfenninger <stefan@pfenninger.org>",
"keywords": "energy systems, visualisation",
"author": null,
"author_email": "Stefan Pfenninger <stefan@pfenninger.org>",
"download_url": "https://files.pythonhosted.org/packages/86/dd/fd97bef2dfd3e765169e1787b0173ea05055b5d0cf4641d6f4e5586dee94/calligraph-0.1.1.dev0.tar.gz",
"platform": null,
"description": "# Calligraph: Calliope model result graphing and visualisation tool\n\n`Calligraph` is a tool to interactively explore and visualise Calliope model results.\n\n> [!IMPORTANT]\n> Note that this is pre-release software and there are likely to bugs. Please [report issues and feedback on GitHub](https://github.com/calliope-project/calligraph)!\n\n> [!CAUTION]\n> Calligraph only works with Calliope 0.7 or higher. If you are running Calliope 0.6 or lower, use the built-in visualisation tools instead.\n\n## Installation\n\n`pip install calligraph`\n\n## Use\n\nSave a solved Calliope model to a NetCDF file with `model.to_netcdf()` or by using the appropriate settings with the Calliope command-line interface. Then run `calligraph` in the command line:\n\n```shell\n$ calligraph your_model_results.nc\n```\n\nThis launches Calligraph's web interface in the default web browser on your system. To use a custom port, supply the `--port PORTNUMBER` option; if you do not want the default web browser to open, specify `-nb` or `--no-browser`.\n\nTo experiment with the built-in urban-scale model:\n\n```python\nimport calliope\nm = calliope.examples.urban_scale(time_subset=None)\nm.run()\nm.to_netcdf(\"urban_scale.nc\")\n```\n\nThen:\n\n```shell\n$ calligraph urban_scale.nc\n```\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Visualisation tool for Calliope.",
"version": "0.1.1.dev0",
"project_urls": {
"changelog": "https://github.com/calliope-project/calligraph/CHANGELOG.md",
"repository": "https://github.com/calliope-project/calligraph",
"website": "https://www.callio.pe/"
},
"split_keywords": [
"energy systems",
" visualisation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93cd496ec9ea02ff7b92740059bea4542bb0e494381263e440b36e7ca58f8292",
"md5": "2329082d628f68c062086ad82538c914",
"sha256": "b51616f5ec878d49c7524621db67279909963ab91cc5d2150900d24017fe7867"
},
"downloads": -1,
"filename": "calligraph-0.1.1.dev0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2329082d628f68c062086ad82538c914",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 17352,
"upload_time": "2024-08-26T07:31:01",
"upload_time_iso_8601": "2024-08-26T07:31:01.456631Z",
"url": "https://files.pythonhosted.org/packages/93/cd/496ec9ea02ff7b92740059bea4542bb0e494381263e440b36e7ca58f8292/calligraph-0.1.1.dev0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "86ddfd97bef2dfd3e765169e1787b0173ea05055b5d0cf4641d6f4e5586dee94",
"md5": "f27d1b62b5b9cd93ab0aa0720d21672f",
"sha256": "ee8c4fe1b57c9f264179a75a2bfdcefb32d2b90e5635b8b73ced534f89d9a975"
},
"downloads": -1,
"filename": "calligraph-0.1.1.dev0.tar.gz",
"has_sig": false,
"md5_digest": "f27d1b62b5b9cd93ab0aa0720d21672f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 16697,
"upload_time": "2024-08-26T07:31:03",
"upload_time_iso_8601": "2024-08-26T07:31:03.521888Z",
"url": "https://files.pythonhosted.org/packages/86/dd/fd97bef2dfd3e765169e1787b0173ea05055b5d0cf4641d6f4e5586dee94/calligraph-0.1.1.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-26 07:31:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "calliope-project",
"github_project": "calligraph",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "calligraph"
}
JSON
