GenericUnstructuredReader¶
Description: Generic reader, reading netcdf file variables into variables using given name map between internal and file variable names
class_name: oceantracker.reader.generic_unstructured_reader.GenericUnstructuredReader
File: oceantracker/reader/generic_unstructured_reader.py
Inheritance: _BaseReader> GenericUnstructuredReader
Parameters:¶
EPSG_transform_code<class 'int'><optional>Description: Integer code needed to enable transformation from/to meters to/from lat/lon (see https://epsg.io/ to find EPSG code for hydro-models meters grid)
default:
Nonemin:
0
class_name<class 'str'><optional>Description: Class name as string A.B.C, used to import this class from python path
default:
None
cords_in_lat_long<class 'bool'><optional>
default:
Falsepossible_values:
[True, False]
dimension_map: nested parameter dictionary
node<class 'str'><isrequired>
default:
node
time<class 'str'><isrequired>
default:
time
vector2Ddim<class 'str'><optional>
default:
None
vector3Ddim<class 'str'><optional>
default:
None
z<class 'str'><optional>
default:
None
field_variables: nested parameter dictionary
bottom_stress<class 'str'><optional>
default:
None
salinity<class 'str'><optional>
default:
None
tide<class 'str'><optional>
default:
None
water_depth<class 'str'><optional>
default:
None
water_temperature<class 'str'><optional>
default:
None
water_velocity:<isrequired>
a list containing type:
[<class 'str'>, None]default list :
['u', 'v', None]can_be_empty_list:
Truefixed_len:
3
wind_stress<class 'str'><optional>
default:
None
field_variables_to_depth_average: <optional>
a list containing type:
[<class 'str'>]default list :
[]can_be_empty_list:
True
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:
None
grid_file<class 'str'><optional>Description: File name with hydrodynamic grid data, as path relative to input_dir, default is get grid from first hindasct file
default:
None
grid_variables: nested parameter dictionary
bottom_cell_index<class 'str'><optional>
default:
None
is_dry_cell<class 'numpy.int8'><optional>Description: Time variable flag of when cell is dry, 1= is dry cell
default:
None
time<class 'str'><isrequired>
default:
time
triangles<class 'str'><isrequired>
default:
None
x: <optional>
a list containing type:
[<class 'str'>]default list :
['x', 'y']can_be_empty_list:
Truefixed_len:
2
zlevel<class 'str'><optional>
default:
None
input_dir<class 'str'><isrequired>
default:
None
isodate_of_hindcast_time_zeroiso8601date<optional>
default:
1970-01-01
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:
10000000min:
1
one_based_indices<class 'bool'><optional>Description: indices in hindcast start at 1, not zero, eg. triangulation nodes start at 1 not zero as in python
default:
Falsepossible_values:
[True, False]
required_file_dimensions: <optional>
a list containing type:
[<class 'str'>]default list :
[]can_be_empty_list:
True
required_file_variables: <optional>
a list containing type:
[<class 'str'>]default list :
[]can_be_empty_list:
True
time_buffer_size<class 'int'><optional>
default:
24min:
2
time_zone<class 'int'><optional>Description: time zone in hours relative to UTC/GMT , eg NZ standard time is time zone 12
default:
Nonemin:
-12max:
12units:
hours
user_note<class 'str'><optional>
default:
None