# 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/26/8f/4bf642ebd8611aff8f4a272fc105e3670f8c346c62b15e8cbc7877e8d45b/calligraph-0.1.1.dev2.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.dev2",
"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": "882c7ff9bb8c9ff532d9834c3c3c7f62bb79272b6c5e7ed18bff658f43378429",
"md5": "4fa54a684565a76d87f1f25ee3aafff8",
"sha256": "c4624ad27bd48f6a225c13a7220fd6d0485347c94d12d8fd36ee44d301733fd0"
},
"downloads": -1,
"filename": "calligraph-0.1.1.dev2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4fa54a684565a76d87f1f25ee3aafff8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 18187,
"upload_time": "2024-10-23T11:38:16",
"upload_time_iso_8601": "2024-10-23T11:38:16.864824Z",
"url": "https://files.pythonhosted.org/packages/88/2c/7ff9bb8c9ff532d9834c3c3c7f62bb79272b6c5e7ed18bff658f43378429/calligraph-0.1.1.dev2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "268f4bf642ebd8611aff8f4a272fc105e3670f8c346c62b15e8cbc7877e8d45b",
"md5": "ac9673445a1007576a2fd294febe43e6",
"sha256": "3d9475dc228c96703b4d1613ba0373a63c0a4cce3b2dcbdb43e35831401e05bf"
},
"downloads": -1,
"filename": "calligraph-0.1.1.dev2.tar.gz",
"has_sig": false,
"md5_digest": "ac9673445a1007576a2fd294febe43e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 17743,
"upload_time": "2024-10-23T11:38:18",
"upload_time_iso_8601": "2024-10-23T11:38:18.213613Z",
"url": "https://files.pythonhosted.org/packages/26/8f/4bf642ebd8611aff8f4a272fc105e3670f8c346c62b15e8cbc7877e8d45b/calligraph-0.1.1.dev2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 11:38:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "calliope-project",
"github_project": "calligraph",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "calliope",
"specs": [
[
">=",
"0.7.0.dev4"
],
[
"<",
"0.8"
]
]
},
{
"name": "panel",
"specs": [
[
">=",
"1.5.2"
],
[
"<",
"1.6"
]
]
},
{
"name": "plotly",
"specs": [
[
">=",
"5"
],
[
"<",
"6"
]
]
},
{
"name": "pyproj",
"specs": [
[
"==",
"3.6.1"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1"
]
]
}
],
"lcname": "calligraph"
}
JSON
