DELF3DFMreader¶
Doc:
short class_name: DELF3DFMreader
full class_name : oceantracker.reader.DEFT3DFM_reader.DELF3DFMreader
Warning
Class is under development may not yet work in all cases, if errors contact developer
Inheritance: > ParameterBaseClass> _BaseReader> _BaseUnstructuredReader> DELF3DFMreader
Parameters:¶
EPSG_code<class 'int'><optional>Description: integer code for coordinate transform of hydro-model, only used if setting “use_geographic_coords”= True and hindcast not in geographic coords, EPSG for New Zealand Transverse Mercator 2000 = 2193, find codes at https://spatialreference.org/
default:
Nonedata_type:
<class 'int'>
class_name<class 'str'><optional>Description: Class name as string A.B.C, used to import this class from python path
default:
Nonedata_type:
<class 'str'>
drop_variables: <optional>Description: - Variables for xarray to ingore, eg. problimatic time variables that wont decode, ie not CFtime standard compliant
a list containing type:
[]default list :
Nonedata_type:
<class 'str'>possible_types:
[]make_list_unique:
Falsemin_len:
0
file_mask<class 'str'><isrequired>Description: Mask for file names, eg “scout*.nc”, finds all files matching in “input_dir” and its sub dirs that match the file_mask pattern
default:
Nonedata_type:
<class 'str'>
input_dir<class 'str'><isrequired>
default:
Nonedata_type:
<class 'str'>
load_fields: <optional>Description: - always load tide and water depth, for dry cells id 2D
a list containing type:
[]default list :
['water_depth']data_type:
<class 'str'>possible_types:
[]make_list_unique:
Falsemin_len:
0
max_numb_files_to_load<class 'int'><optional>Description: Only read no more than this number of hindcast files, useful when setting up to speed run
default:
10000000data_type:
<class 'int'>min:
1
name<class 'str'><optional>Description: Name used to refer to class in code and output, = None for core claseses
default:
Nonedata_type:
<class 'str'>
one_based_indices<class 'bool'><optional>Description: DELFT 3D has indices starting at 1 not zero
default:
Truedata_type:
<class 'bool'>possible_values:
[True, False]
time_buffer_size<class 'int'><optional>
default:
24data_type:
<class 'int'>min:
2
user_note<class 'str'><optional>
default:
Nonedata_type:
<class 'str'>
variable_signature: <optional>Description: - Variable names used to test if file is this format
a list containing type:
[]default list :
['mesh2d_waterdepth', 'mesh2d_face_nodes']data_type:
<class 'str'>possible_types:
[]make_list_unique:
Falsemin_len:
0
vertical_regrid<class 'bool'><optional>Description: Convert vertical grid to same sigma levels across domain
default:
Truedata_type:
<class 'bool'>possible_values:
[True, False]
Expert Parameters:¶
geographic_coords<class 'bool'><optional>Description: Read file coords as geographic values,normaly auto-detects if in geographic coords, using this setting forces reading as geograraphic coord if auto-dectect fails
default:
Falsedata_type:
<class 'bool'>possible_values:
[True, False]