bluemath_tk.wrappers.xbeach package
Submodules
bluemath_tk.wrappers.xbeach.xbeach_example module
bluemath_tk.wrappers.xbeach.xbeach_wrapper module
- class bluemath_tk.wrappers.xbeach.xbeach_wrapper.XBeachModelWrapper(*args, **kwargs)[source]
Bases:
BaseModelWrapperWrapper for the XBeach model. https://xbeach.readthedocs.io/en/latest/
- default_parameters
The default parameters type for the wrapper.
- Type:
dict
- available_launchers
The available launchers for the wrapper.
- Type:
dict
- available_launchers = {'geoocean-cluster': 'launchXbeach.sh'}
- build_case(case_context: dict, case_dir: str) None[source]
Build the input files for a case.
- Parameters:
case_context (dict) – The case context.
case_dir (str) – The case directory.
- default_parameters = {'comptime': {'description': 'The computational time.', 'type': <class 'int'>, 'value': 3600}, 'wbctype': {'description': 'The time step for the simulation.', 'type': <class 'str'>, 'value': 'off'}}
- join_postprocessed_files(postprocessed_files: List[Dataset]) Dataset[source]
Join postprocessed files in a single Dataset.
- Parameters:
postprocessed_files (list) – The postprocessed files.
- Returns:
The joined xarray.Dataset.
- Return type:
xr.Dataset
- monitor_cases(value_counts: str = None) DataFrame | dict[source]
Monitor the cases based on different model log files.
- postprocess_case(case_num: int, case_dir: str, output_vars: List[str] = None, overwrite_output: bool = True) Dataset[source]
Convert tab output files to netCDF file.
- Parameters:
case_num (int) – The case number.
case_dir (str) – The case directory.
output_vars (list, optional) – The output variables to postprocess. Default is None.
overwrite_output (bool, optional) – Overwrite the output.nc file. Default is True.
- Returns:
The postprocessed Dataset.
- Return type:
xr.Dataset