swot_simulator.settings.Parameters.CONFIG_VALUES

Parameters.CONFIG_VALUES: Dict[str, Tuple[Any, Any, str]] = {'area': (None, [<class 'float'>, 4], 'Geographical area to simulate defined by the minimum and maximum corner point :lon_min, lat_min, lon_max, lat_max. Default: -180, -90, 180, 90'), 'beam_position': ([-20, 20], [<class 'float'>, 2], "Number of beam used to correct wet troposphere signal (1, 2 or 'both')"), 'central_pixel': (False, <class 'bool'>, 'If true, the swath, in the final dataset, will contain a center pixel divided in half by the reference ground track'), 'complete_product': (False, <class 'bool'>, "If true, the generated netCDF file will be the complete product compliant with SWOT's Product Description Document (PDD), otherwise only the calculated variables will be written to the netCDF file"), 'corrected_roll_phase_dataset': (None, <class 'str'>, 'Estimated roll phase dataset. Default: None'), 'cycle_duration': (None, <class 'float'>, 'Duration of a cycle in number of fractional days. By default, this value is read from the ephemeris file)'), 'delta_ac': (2.0, <class 'float'>, 'Distance, in km, between two points across track direction'), 'delta_al': (2.0, <class 'float'>, 'Distance, in km, between two points along track direction'), 'ephemeris': (None, <class 'str'>, "Ephemeris file to read containing the satellite's orbit."), 'ephemeris_cols': (None, [<class 'int'>, 3], 'Index of columns to read in the ephemeris file containing, respectively, longitude in degrees, latitude in degrees and the number of seconds elapsed since the start of the orbit. Default: [1, 2, 0]'), 'error_spectrum': (None, <class 'str'>, 'File containing spectrum of instrument error'), 'half_gap': (10.0, <class 'float'>, 'Distance, in km, between the nadir and the center of the first pixel of the swath'), 'half_swath': (60.0, <class 'float'>, 'Distance, in km, between the nadir and the center of the last pixel of the swath'), 'height': (None, <class 'float'>, 'Satellite altitude (m). By default, this value is read from the ephemeris file.'), 'karin_noise': (None, <class 'str'>, 'KaRIN file containing spectrum for several SWH'), 'len_repeat': (20000.0, <class 'float'>, 'Repeat length'), 'nadir': (False, <class 'bool'>, 'True to generate Nadir products'), 'nbeam': (2, <class 'swot_simulator.settings.NumberOfBeams'>, "Number of beam used to correct wet troposphere signal (1, 2 or 'both')"), 'noise': (None, [<class 'str'>, -1], 'This option defined the error to simulate. Allowed values are "altimeter," "baseline_dilation," "corrected_roll_phase," "karin," "orbital," "roll_phase," "timing," and "wet_troposphere." The calculation of roll errors can be simulated, option "roll_phase," or interpolated option "corrected_roll_phase," from the dataset specified by the value of the option "roll_phase_dataset." Therefore, these two options are mutually exclusive. In other words, if the "roll_phase" option is present, the "corrected_roll_phase" option must be omitted, and vice versa.'), 'nseed': (0, <class 'int'>, 'Seed for RandomState. Must be convertible to 32 bit unsigned integers'), 'product_type': ('expert', <class 'str'>, "Type of SWOT product to be generated. Possible products are 'basic', 'expert', 'unsmoothed' and 'wind_wave'. Default to 'expert'"), 'requirement_bounds': (None, [<class 'float'>, 2], 'Limits of SWOT swath requirements. Measurements outside the span will be set with fill values'), 'shift_lon': (None, <class 'float'>, 'Orbit shift in longitude (degrees). Default 0.'), 'shift_time': (None, <class 'swot_simulator.settings.TimeDelta'>, 'Orbit shift in time (seconds). Default 0.'), 'sigma': (6.0, <class 'float'>, 'Gaussian footprint of sigma (km)'), 'ssh_plugin': (None, <class 'swot_simulator.plugins.Interface'>, 'The plug-in handling the SSH interpolation under the satellite swath'), 'swath': (True, <class 'bool'>, 'True to generate swath products'), 'swh': (2.0, <class 'float'>, 'SWH for the region'), 'swh_plugin': (None, <class 'swot_simulator.plugins.Interface'>, "SWH plugin to interpolate model SWH on the SWOT grid. Use only 'expert' or 'wind_wave' products that have the swh in its output"), 'temporal_overlap': (None, <class 'float'>, 'Simulate products overlapping by this amount of time, in seconds, with the previous and next products'), 'working_directory': ('/home/docs/swot_simulator', <class 'str'>, "The working directory. By default, files are generated in the user's root directory")}

Known parameters.