calligraph

Calligraph: A tool to interactively explore and visualise Calliope model results

https://github.com/calliope-project/calligraph

Science Score: 44.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
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Calligraph: A tool to interactively explore and visualise Calliope model results

Basic Info
Statistics
  • Stars: 7
  • Watchers: 5
  • Forks: 1
  • Open Issues: 12
  • Releases: 2
Created almost 2 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog License Citation

README.md

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!

[!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

Owner

  • Name: Calliope
  • Login: calliope-project
  • Kind: organization

A multi-scale energy systems modelling framework

Citation (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: 9
  • Release event: 1
  • Issues event: 11
  • Watch event: 6
  • Delete event: 3
  • Issue comment event: 18
  • Push event: 17
  • Pull request review comment event: 3
  • Pull request review event: 4
  • Pull request event: 12
Last Year
  • Create event: 9
  • Release event: 1
  • Issues event: 11
  • Watch event: 6
  • Delete event: 3
  • Issue comment event: 18
  • Push event: 17
  • Pull request review comment event: 3
  • Pull request review event: 4
  • Pull request event: 12

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 35 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
pypi.org: calligraph

Visualisation tool for Calliope.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 35 Last month
Rankings
Dependent packages count: 10.4%
Average: 34.6%
Dependent repos count: 58.7%
Maintainers (1)
Last synced: 6 months ago

Dependencies

pyproject.toml pypi
requirements.txt pypi
  • click ==8.1
  • panel >=1.3,<1.4
  • plotly >=5,<6
  • pyproj ==3.6.1