Logo
  • 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
      • Space- and time- slicing
      • Layer selection
    • Reducing data
      • Spatial reductions
      • Time reductions
      • Layer reductions
      • The RedSpec object
    • Filtering data
    • Operations on field layers
      • Arithmetic operations
      • The apply method
    • Selecting a geographical region
    • Changing the units
    • Selecting overlapping entries
    • Combining fields
      • Unite
      • Join
  • 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
      • Latitudinal Average
      • Longitudinal Average
      • Spatial Average
      • Longitudinal Sum
      • Latitudinal Sum
      • Spatial Sum
  • API Reference
    • canopy.core
      • canopy.core.constants
      • canopy.core.field
        • Field
      • canopy.core.frameops
        • apply_div()
        • apply_function()
        • apply_mul()
        • apply_reduction()
        • apply_sub()
        • apply_sum()
        • check_columns()
        • check_indices_match()
        • get_base_freq()
        • get_time_index()
        • is_monthly_freq()
        • is_yearly_freq()
        • parse_freq()
        • parse_timeop()
        • reduce_grid()
        • reduce_time()
        • select_slice()
      • canopy.core.redspec
        • RedSpec
      • canopy.core.grid.grid_abc
        • Grid
      • canopy.core.grid.grid_empty
        • GridEmpty
      • canopy.core.grid.grid_lonlat
        • GridLonLat
        • av_both()
        • av_lat()
        • av_lon()
        • sum_both()
        • sum_lat()
        • sum_lon()
      • canopy.core.grid.grid_sites
        • GridSites
        • av_both()
        • sum_both()
      • canopy.core.grid.registry
        • check_gridop()
        • create_grid()
        • get_grid()
        • get_grid_type()
        • get_gridop()
        • register_grid()
        • register_gridop()
    • canopy.json
      • canopy.json.json_functions
        • distribution()
        • latitudinal_plot()
        • map_diff()
        • map_simple()
        • preprocess_data()
        • static()
        • time_series()
      • canopy.json.json_registry module
        • get_json_function()
        • register_json()
      • canopy.json.run_json module
        • load_json_config()
        • run_json()
        • warn_unused_keys()
    • canopy.readers
      • canopy.readers.fluxnet2015
        • fluxnet2015()
      • canopy.readers.lpjguess
        • lpjg_annual()
        • lpjg_monthly()
      • canopy.readers.registry
        • get_format_description()
        • get_reader()
        • register_reader()
        • register_reader_desc()
    • canopy.source_data
      • canopy.source_data.registry
    • canopy.sources
      • canopy.sources.registry
        • get_source()
        • register_source()
      • canopy.sources.source_abc
        • Source
      • canopy.sources.source_fluxnet2015
      • canopy.sources.source_lpjguess
    • canopy.util
      • canopy.util.checks
        • check_disjoint_coords()
        • check_field_contains_layers()
        • check_grids_have_same_axes()
        • check_indices_match()
        • check_spatial_coords_match()
        • check_time_series_consistency()
        • check_time_series_match()
      • canopy.util.compare_ts
        • compare_ts()
      • canopy.util.raster
        • Raster
      • canopy.util.make_lines
        • make_lines()
      • canopy.util.overlap
        • overlap()
      • canopy.util.unite
        • unite()
      • canopy.util.join
        • join()
    • canopy.visualization
      • canopy.visualization.distribution_plot
        • make_distribution_plot()
      • canopy.visualization.map
        • make_diff_map()
        • make_simple_map()
      • canopy.visualization.plot_functions
        • format_value_label()
        • get_color_palette()
        • get_field_metadata()
        • handle_figure_output()
        • make_dark_mode()
        • save_figure_png()
        • set_axis_style()
      • canopy.visualization.multiple_figs
        • create_wrapper_from_locals()
        • multiple_figs()
        • setup_figure_and_axes()
      • canopy.visualization.map.projections
      • canopy.visualization.static_plot
        • make_static_plot()
      • canopy.visualization.taylor_diagram
        • make_taylor_diagram()
      • canopy.visualization.line_plot.time_series
        • make_time_series()
      • canopy.visualization.line_plot.latitudinal_plot
        • make_latitudinal_plot()
canopy
  • API Reference
  • View page source
Previous Next

API Reference

This section contains the API reference for all public modules in the canopy package. Each entry links to the documentation for that module, automatically generated using autodoc.

  • canopy.core
    • canopy.core.constants
    • canopy.core.field
    • canopy.core.frameops
    • canopy.core.redspec
    • canopy.core.grid.grid_abc
    • canopy.core.grid.grid_empty
    • canopy.core.grid.grid_lonlat
    • canopy.core.grid.grid_sites
    • canopy.core.grid.registry
  • canopy.json
    • canopy.json.json_functions
    • canopy.json.json_registry module
    • canopy.json.run_json module
  • canopy.readers
    • canopy.readers.fluxnet2015
    • canopy.readers.lpjguess
    • canopy.readers.registry
  • canopy.source_data
    • canopy.source_data.registry
  • canopy.sources
    • canopy.sources.registry
    • canopy.sources.source_abc
    • canopy.sources.source_fluxnet2015
    • canopy.sources.source_lpjguess
  • canopy.util
    • canopy.util.checks
    • canopy.util.compare_ts
    • canopy.util.raster
    • canopy.util.make_lines
    • canopy.util.overlap
    • canopy.util.unite
    • canopy.util.join
  • canopy.visualization
    • canopy.visualization.distribution_plot
    • canopy.visualization.map
    • canopy.visualization.plot_functions
    • canopy.visualization.multiple_figs
    • canopy.visualization.map.projections
    • canopy.visualization.static_plot
    • canopy.visualization.taylor_diagram
    • canopy.visualization.line_plot.time_series
    • canopy.visualization.line_plot.latitudinal_plot
Previous Next

© Copyright 2025, David M. Belda & Adrien Damseaux.

Built with Sphinx using a theme provided by Read the Docs.