sdynpy.fileio.sdynpy_escdf.from_rattlesnake_modal_parameters

• Module: sdynpy.fileio.sdynpy_escdf

• Source: GitHub

Signature¶

def sdynpy.fileio.sdynpy_escdf.from_rattlesnake_modal_parameters(dataset_name, modal_dataset, environment_name=None, descriptive_name='')

Generates a “modal_test_parameters” object from modal output

Parameters¶

• dataset_name : str The name of the dataset to be generated

• modal_dataset : netCDF4.Dataset A dataset produced by loading the netcdf4 output file.

• environment_name : str, optional Name of the environment. Must be specified if more than one environment exists in the file

• descriptive_name : str, optional A description of the generated dataset, by default ‘’.

Returns¶

• escdf.Dataset

• A dataset with the type “modal_test_parameters” containing

• modal parameters