ROMSreader¶
Doc:
short class_name: ROMSreader
full class_name : oceantracker.reader.ROMS_reader.ROMSreader
Inheritance: > ParameterBaseClass> _BaseReader> _BaseStructuredReader> ROMSreader
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: - 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'>possible_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:
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: File has indices starting at 1, not pythons zero, eg node numbers in triangulation/simplex
default:
Falsedata_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 :
['ocean_time', 'mask_psi', 'lat_psi', 'lon_psi', 'h', 'zeta', 'u', 'v']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]