unstructured_FVCOM¶
Doc:
short class_name: unstructured_FVCOM
full class_name : oceantracker.reader.FVCOM_reader.unstructured_FVCOM
Inheritance: > ParameterBaseClass> _BaseReader> unstructured_FVCOM
Parameters:¶
EPSG<class 'int'><optional>Description: integer code for coordinate transform of hydro-model, only used if running in lon-lat mode and code not in hindcast, eg. EPSG for New Zealand Transverse Mercator 2000 = 2193, find codes at https://spatialreference.org/
default:
Nonedata_type:
<class 'int'>expert:
Falseobsolete:
False
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'>expert:
Falseobsolete:
False
field_variables: <optional>Description: - parameter obsolete, use “load_fields” parameter, with field_variable_map if needed
a list containing type:
[]default list :
Nonedata_type:
<class 'str'>expert:
Falseobsolete:
Truepossible_types:
[]make_list_unique:
Truemin_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'>expert:
Falseobsolete:
False
hydro_model_cords_in_lat_long<class 'bool'><optional>Description: Force conversion given nodal lat longs to a UTM metres grid, only used if lat long coordinates not auto detected
default:
Falsedefault:
Falsedata_type:
<class 'bool'>expert:
Falseobsolete:
Falsepossible_values:
[True, False]
input_dir<class 'str'><isrequired>
default:
Nonedata_type:
<class 'str'>expert:
Falseobsolete:
False
load_fields: <optional>Description: - A list of names of any additional variables to read and interplolate to give particle values, eg. a concentration field (water_veloctiy, tide and water_depth fields are always loaded). If a given name is in field_variable_map, then the mapped file variables will be used internally and in output. If not the given file variable name will be used internally and in particle property output. For any additional vector fields user must supply a file variable map in the “field_variable_map” parameter
a list containing type:
[]default list :
Nonedata_type:
<class 'str'>expert:
Falseobsolete:
Falsepossible_types:
[]make_list_unique:
Truemin_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:
10000000default:
10000000data_type:
<class 'int'>expert:
Falseobsolete:
Falsemin:
1
time_buffer_size<class 'int'><optional>
default:
24default:
24data_type:
<class 'int'>expert:
Falseobsolete:
Falsemin:
2
user_note<class 'str'><optional>
default:
Nonedata_type:
<class 'str'>expert:
Falseobsolete:
False
vertical_regrid<class 'bool'><optional>Description: Convert vertical grid to same sigma levels across domain
default:
Truedefault:
Truedata_type:
<class 'bool'>expert:
Falseobsolete:
Falsepossible_values:
[True, False]