Skip to main content
Ctrl+K

HydroMT Core

  • About
  • Getting started
  • User guide
  • Developer guide
  • API
    • What's new
  • GitHub
  • Deltares
  • About
  • Getting started
  • User guide
  • Developer guide
  • API
  • What's new
  • GitHub
  • Deltares

Section Navigation

Developer Guide

  • Architecture
  • Plugin Developer Guide
    • Starting your own HydroMT Plugin
    • Implementing your own HydroMT Model class
    • Creating your own Model Components
    • Pre-defined Data Catalog for your plugin
    • Custom Data Driver and Resolver
    • Linking your own custom objects to HydroMT core API
    • Testing your plugin
    • Migrating your plugin to v1
  • Core Developer Guide
    • Developer’s guide
    • Adding Documentation
    • Developer installation guide
  • Developer Guide
  • Plugin Developer guide

Plugin Developer guide#

  • Starting your own HydroMT Plugin
    • Create your own plugin repository
      • Typical HydroMT repository structure
  • Implementing your own HydroMT Model class
    • Initialisation
    • Additional Model properties
    • Setup basic model objects
    • Setup methods
    • Processes
  • Creating your own Model Components
    • Implementing a component
      • Initialisation
      • Required attributes
  • Pre-defined Data Catalog for your plugin
  • Custom Data Driver and Resolver
    • Custom Drivers
      • Implementing a Drivers
    • Custom Resolver
      • Implementing a Resolver
      • Handling non-existent data
  • Linking your own custom objects to HydroMT core API
  • EntryPoints
  • Testing your plugin
    • Testing model components
    • Testing models
    • Testing your plugin as a whole
  • Migrating your plugin to v1
    • Model and ModelComponent
      • New ModelComponent class
      • Changes to the yaml HydroMT configuration file format
      • Model region and geo-spatial components
      • Removing support for ini and toml HydroMT configuration files
      • Implementing Model Components (for developers)
        • Adding Components to a Model
        • Removed Model attributes
    • DataCatalog
      • Changes to the data catalog yaml file format
      • Removing dictionary-like features for the DataCatalog
      • Split the responsibilities of the DataAdapter into separate classes
        • DataSource
        • URIResolver
        • Driver
        • DataAdapter
    • Package API
    • Logging
    • Plugins

previous

Architecture

next

Starting your own HydroMT Plugin

© Copyright Deltares.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.