Canopy Documentation

canopy is an open source python project designed to support research in the field of vegetation dynamics and climate modelling by providing tools for analysing and visualising Dynamic Global Vegetation Model (DGVM) and Land Surface Models (LSM) outputs.

To find our gallery website, go to https://canopy.imk-ifu.kit.edu/

The gallery is an interactive website showcasing figures created with canopy, where each image links to the code that generated it. Users can also submit their own canopy code (Python or JSON) and figure to be featured, helping build a collection of examples that make learning canopy easy and inspiring.

Example data

All the data files used in this documentation can be downloaded from Zenodo.

To use the example data, download the archive and unpack it in your working directory:

tar -xzf example_data.tar.gz

After unpacking, you will have an example_data folder containing all the data files. Make sure to run the examples from the directory where you unpacked the data, or adjust the file paths accordingly.

• Quick Start
  • Interactive mode
  • JSON mode
• The canopy data model
  • The Field object
  • The DataFrame
  • The Grid object
  • Creating a Field
• Basic data manipulation
  • Reading files
  • Data sources
  • Slicing data
  • Reducing data
  • Filtering data
  • Operations on field layers
  • Selecting a geographical region
  • Changing the units
  • Selecting overlapping entries
  • Combining fields
• Visualization
  • Make a map
  • Make a time-series
  • Make a latitudinal plot
  • Make a static plot
  • Make a distribution plot
  • Make a Taylor diagram
  • Save figure and multiple plots in one figure
• JSON
  • What you can do
  • What you cannot do
• Technical Documentation
  • Spatial Reduction Operations on the ‘lonlat’ grid
• API Reference
  • canopy.core
  • canopy.json
  • canopy.readers
  • canopy.source_data
  • canopy.sources
  • canopy.util
  • canopy.visualization