Skip to main content
Ctrl+K
🚧 Development documentation
HydroModPy 2.0.0a1 documentation - Home HydroModPy 2.0.0a1 documentation - Home
  • Home
  • Get started
  • User Guide
  • Python API
  • CLI
    • Gallery
    • Theory
    • Developer
    • About
  • GitHub
  • Issues
  • Google Group
  • Home
  • Get started
  • User Guide
  • Python API
  • CLI
  • Gallery
  • Theory
  • Developer
  • About
  • GitHub
  • Issues
  • Google Group

Section Navigation

Verbs

  • hmp.open
  • hmp.index
  • hmp.run
  • hmp.calibrate
  • hmp.compare_pair
  • hmp.report
  • hmp.read
  • hmp.doctor

Object API

  • hmp.Project

Generated

  • Module reference
    • open
    • read
    • export
    • run
    • calibrate
    • index
    • compare_pair
    • report
    • bootstrap_proj
    • doctor
    • hydromodpy.config
    • hydromodpy.results
      • Catalog
    • hydromodpy.display
      • get
      • list_figures
      • names
      • register
      • BaseFigure
      • Figure
      • FigureSpec
    • hydromodpy.calibration
      • validate_calib_output
      • build_objective_from_config
      • apply_parameter_to_config
      • available_optimizers
      • build_optimizer
      • register_optimizer
      • discover_calibrable
      • materialize_candidate
      • CalibrationEngine
      • CalibrationSession
      • CalibrationReport
      • Optimizer
      • Objective
      • ObjectiveValue
      • ObservationSet
      • SimulationOutput
      • ScalarObjective
      • CompositeObjective
      • ConfigBlockObjective
      • Calibrable
      • CalibParameter
      • ParameterSpace
      • ParamSuggestion
      • EvaluationResult
    • hydromodpy.catalog
      • InputsNamespace
    • hydromodpy.project
      • Project
      • ProjectCatalog
      • ProjectDataAccessor
      • ProjectRunner
      • ProjectRunsAccessor
    • hydromodpy.analysis
    • hydromodpy.core
      • clear_whitebox_backend_cache
      • get_whitebox_backend
      • Workspace
      • WorkspacePathRegistry
      • ExecutionRegistry
      • WorkflowContext
      • LoadedDataContext
      • SetupContext
      • ResolvedSimulationTimeWindow
      • WhiteboxWorkflowsBackend
    • hydromodpy.data
      • DataManagers
      • DataLoadPlan
      • DataPlanner
      • DataManagersRuntimeLoader
    • hydromodpy.discretization
    • hydromodpy.physics
      • normalize_flow_regime
      • Flow
      • ProcessSpatial
      • Transport
    • hydromodpy.reporting
    • hydromodpy.schema
      • build_config_meta
      • build_field_validators
      • export_full_schema
      • validate_field
      • ValidationResult
    • hydromodpy.simulation
      • ensure_flow
      • ensure_process_context
      • ensure_transport
      • ExecutionRegistry
      • WorkflowContext
      • LoadedDataContext
      • ProcessRun
      • RunContext
      • RunExecutionResult
      • SetupContext
      • ResolvedSimulationTimeWindow
      • SimulationPlan
      • SimulationPlanner
      • Workspace
    • hydromodpy.solver
      • RunResult
      • SolverAdapter
    • hydromodpy.spatial
      • CatchmentZonesField
      • RasterSupport
      • Surface
      • PreparedSurfaceSampler
      • Domain
      • FieldParam
      • CatchmentDelineation
      • CellBlock
      • CellType
      • HydroMesh
    • hydromodpy.workflow
      • WorkflowContext
    • Docstring Policy

Indices

  • General Index
  • Python Module Index
  • Python API
  • API Reference
  • hydromodpy.display
  • register

register#

hydromodpy.display.register(cls)[source]#

Class decorator. Registers cls under cls.spec.name.

Parameters:

cls (type[BaseFigure])

Return type:

type[BaseFigure]

previous

names

next

BaseFigure

On this page
  • register()

© Copyright 2021.

Created using Sphinx 7.4.7.