Logo image Logo image
  • User Guide
  • Contributor Guide
  • Developer Guide
  • Science Library
  • API Reference
  • Change Log
  • Licence
  • Index
  • Model
    • unifhy.Model.from_yaml
    • unifhy.Model.to_yaml
    • unifhy.Model.initialise_transfers_from_dump
    • unifhy.Model.spin_up
    • unifhy.Model.simulate
    • unifhy.Model.resume
    • unifhy.Model.identifier
    • unifhy.Model.config_directory
    • unifhy.Model.saving_directory
    • unifhy.Model.surfacelayer
    • unifhy.Model.subsurface
    • unifhy.Model.openwater
    • unifhy.Model.nutrientsurfacelayer
    • unifhy.Model.nutrientsubsurface
    • unifhy.Model.nutrientopenwater
  • SurfaceLayerComponent
  • SubSurfaceComponent
  • OpenWaterComponent
  • NutrientSurfaceLayerComponent
  • NutrientSubSurfaceComponent
  • NutrientOpenWaterComponent
  • DataComponent
  • NullComponent
  • TimeDomain
    • unifhy.TimeDomain.from_datetime_sequence
    • unifhy.TimeDomain.from_start_end_step
    • unifhy.TimeDomain.from_field
    • unifhy.TimeDomain.is_time_equal_to
    • unifhy.TimeDomain.spans_same_period_as
    • unifhy.TimeDomain.time
    • unifhy.TimeDomain.bounds
    • unifhy.TimeDomain.units
    • unifhy.TimeDomain.calendar
    • unifhy.TimeDomain.period
    • unifhy.TimeDomain.timedelta
  • LatLonGrid
    • unifhy.LatLonGrid.from_extent_and_resolution
    • unifhy.LatLonGrid.from_field
    • unifhy.LatLonGrid.is_space_equal_to
    • unifhy.LatLonGrid.spans_same_region_as
    • unifhy.LatLonGrid.is_matched_in
    • unifhy.LatLonGrid.route
    • unifhy.LatLonGrid.shape
    • unifhy.LatLonGrid.axes
    • unifhy.LatLonGrid.X
    • unifhy.LatLonGrid.Y
    • unifhy.LatLonGrid.X_bounds
    • unifhy.LatLonGrid.Y_bounds
    • unifhy.LatLonGrid.X_name
    • unifhy.LatLonGrid.Y_name
    • unifhy.LatLonGrid.land_sea_mask
    • unifhy.LatLonGrid.flow_direction
    • unifhy.LatLonGrid.cell_area
  • RotatedLatLonGrid
    • unifhy.RotatedLatLonGrid.from_extent_and_resolution
    • unifhy.RotatedLatLonGrid.from_field
    • unifhy.RotatedLatLonGrid.is_space_equal_to
    • unifhy.RotatedLatLonGrid.spans_same_region_as
    • unifhy.RotatedLatLonGrid.is_matched_in
    • unifhy.RotatedLatLonGrid.route
    • unifhy.RotatedLatLonGrid.shape
    • unifhy.RotatedLatLonGrid.axes
    • unifhy.RotatedLatLonGrid.X
    • unifhy.RotatedLatLonGrid.Y
    • unifhy.RotatedLatLonGrid.X_bounds
    • unifhy.RotatedLatLonGrid.Y_bounds
    • unifhy.RotatedLatLonGrid.X_name
    • unifhy.RotatedLatLonGrid.Y_name
    • unifhy.RotatedLatLonGrid.land_sea_mask
    • unifhy.RotatedLatLonGrid.flow_direction
    • unifhy.RotatedLatLonGrid.cell_area
  • BritishNationalGrid
    • unifhy.BritishNationalGrid.from_extent_and_resolution
    • unifhy.BritishNationalGrid.from_field
    • unifhy.BritishNationalGrid.is_space_equal_to
    • unifhy.BritishNationalGrid.spans_same_region_as
    • unifhy.BritishNationalGrid.is_matched_in
    • unifhy.BritishNationalGrid.route
    • unifhy.BritishNationalGrid.shape
    • unifhy.BritishNationalGrid.axes
    • unifhy.BritishNationalGrid.X
    • unifhy.BritishNationalGrid.Y
    • unifhy.BritishNationalGrid.X_bounds
    • unifhy.BritishNationalGrid.Y_bounds
    • unifhy.BritishNationalGrid.X_name
    • unifhy.BritishNationalGrid.Y_name
    • unifhy.BritishNationalGrid.land_sea_mask
    • unifhy.BritishNationalGrid.flow_direction
    • unifhy.BritishNationalGrid.cell_area
  • DataSet
    • unifhy.DataSet.load_from_file
On this page
  • Model
  • Components
  • Time
  • Space
  • Data

API Reference

UML class diagram

Fig. 3: UML Class Diagram of unifhy.

Model

  • Model

Components

  • SurfaceLayerComponent
  • SubSurfaceComponent
  • OpenWaterComponent
  • NutrientSurfaceLayerComponent
  • NutrientSubSurfaceComponent
  • NutrientOpenWaterComponent
  • DataComponent
  • NullComponent

Time

  • TimeDomain

Space

  • LatLonGrid
  • RotatedLatLonGrid
  • BritishNationalGrid

Data

  • DataSet

© Copyright 2020-2024, UK Centre for Ecology & Hydrology.

Created using Sphinx 4.5.0.