HydroBayesCal

Getting started

  • About HydroBayesCal
    • What is HydroBayesCal?
    • Purpose and motivation
    • Where to go next
  • Installation
    • Python environment
      • Option A — from PyPI (recommended)
      • Option B — conda / mamba (development)
      • Option C — editable install from a clone
    • Numerical-model bindings
      • TELEMAC
      • OpenFOAM
      • Delft3D-FLOW
    • Check your installation
    • Building and releasing (maintainers)
      • Versioning
      • Releasing
      • Building locally

User guide

  • Bayesian Calibration Workflow
    • Step 0: Wet your (TELEMAC) Model
    • Step 1: Assign user input parameters
      • Functioning of the HydroSimulations Class
      • TelemacModel Class (Telemac specific parameters)
    • Step 2: Bayesian model optimization
    • Step 3: Post-calibration data
  • TELEMAC & OpenFOAM Bindings
    • TELEMAC simulation folder
    • OpenFOAM simulation folder
    • HydroBayesCal parameters
    • Experiment Design Definition
      • Example Usage
    • Run Numerical Model with Experiment Design
      • Example Usage
    • Run BAL Calibration
      • Example Usage
      • Surrogate-Assisted BAL Calibration Outputs
  • Using HydroBayesCal with TELEMAC
    • Prerequisites
    • The TELEMAC simulation folder
    • Measurement / calibration points
    • TELEMAC-specific parameters
    • Calibration parameters and TELEMAC keywords
    • Running the calibration
    • See also
  • Using HydroBayesCal with OpenFOAM
    • Prerequisites
    • The OpenFOAM case template
    • OpenFOAM-specific parameters
    • Calibration parameters
    • Running the calibration
    • See also
  • Using HydroBayesCal with Delft3D-FLOW
    • Intended scope
    • Software-specific keywords (planned)
    • See also
  • Use Cases
    • TELEMAC
      • Site description
      • Pre-processing
      • Run BAL with HydroBayesCal
    • OpenFOAM
      • Site description
      • Pre-processing
      • Run BAL with HydroBayesCal

Reference

  • Code Structure
    • Architecture at a glance (UML)
    • The calibration pipeline
    • Package layout
  • API Reference
    • Binding layer
      • Abstract base class
      • TELEMAC binding
      • OpenFOAM binding
      • Delft3D-FLOW binding (planned)
    • Surrogate model and Bayesian Active Learning
      • Gaussian Process Emulators
      • Bayesian inference and sequential design
    • Shared utilities
      • append_new_line()
      • call_process()
      • calculate_settling_velocity()
      • concatenate_csv_pts()
      • lookahead()
      • str2seq()
      • log_actions()
      • update_collocation_pts_file()
      • save_data()
      • rearrange_array()
      • update_json_file()
      • delete_slf()
      • filter_model_outputs()
      • interpolate_values()
      • rasterize()
      • classify_mu()
      • parse_classes_keyword()
      • update_gaia_class_line()
      • classify_parameters_tm_gaia()
      • vtk_to_2dm()
      • twodm2SLF()
  • References
    • Core methodology
    • Applications
    • Software dependency
  • Disclaimer and License
    • Disclaimer (general)
    • BSD 3-Clause License
HydroBayesCal
  • Overview: module code

All modules for which code is available

  • hydroBayesCal.delft3d.control_delft3d
  • hydroBayesCal.function_pool
  • hydroBayesCal.hysim
  • hydroBayesCal.openfoam.control_openfoam
  • hydroBayesCal.surrogate.bal_functions
  • hydroBayesCal.surrogate.exploration
  • hydroBayesCal.surrogate.gpe_gpytorch
  • hydroBayesCal.surrogate.gpe_skl
  • hydroBayesCal.telemac.control_telemac

© Copyright 2022-2026, the HydroBayesCal authors.

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