You're reading the documentation for a development version. For the latest released version, please have a look at v0.8.2.

snl_d3d_cec_verify.runner package

snl_d3d_cec_verify.runner.run_dflowfm(d3d_bin_path, model_path, model_file, omp_num_threads=1)

Run a Delft3D flexible mesh simulation, given an existing Delft3D installation and a prepared model.

Currently only available for Windows and Linux.

Parameters:

  • d3d_bin_path (Union[str, Path]) – path to the bin folder generated when compiling Delft3D

  • model_path (Union[str, Path]) – path to folder containing the Delft3D model files

  • omp_num_threads (int) – The number of CPU threads to use, defaults to 1

Raises:

  • OSError – if function is called on an unsupported operating system

  • FileNotFoundError – if the Delft3D entry point or model folder could not be found

  • RuntimeError – if the Delft3D simulation outputs to stderr, for any reason

Return type:

Popen

snl_d3d_cec_verify.runner.run_dflow2d3d(d3d_bin_path, model_path)

Run a Delft3D structured mesh simulation, given an existing Delft3D installation and a prepared model.

Currently only available for Windows and Linux.

Parameters:

  • d3d_bin_path (Union[str, Path]) – path to the bin folder generated when compiling Delft3D

  • model_path (Union[str, Path]) – path to folder containing the Delft3D model files

Raises:

  • OSError – if function is called on an unsupported operating system

  • FileNotFoundError – if the Delft3D entry point or model folder could not be found

  • RuntimeError – if the Delft3D simulation outputs to stderr, for any reason

Return type:

Popen