Skip to content

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

License

Notifications You must be signed in to change notification settings

calliope-project/calligraph

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

$ 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:

import calliope
m = calliope.examples.urban_scale(time_subset=None)
m.run()
m.to_netcdf("urban_scale.nc")

Then:

$ calligraph urban_scale.nc

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages