Simulation settings

settings.area = None

Geographical area to simulate defined by the minimum and maximum corner point :lon_min, lat_min, lon_max, lat_max

Default: None equivalent to the area covering the Earth: -180, -90, 180, 90

settings.beam_position = [-20, 20]

Beam position if there are 2 beams (in km from nadir):

settings.central_pixel = True

If true, the swath, in the final dataset, will contain a center pixel divided in half by the reference ground track.

settings.complete_product = False

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.

settings.corrected_roll_phase_dataset = '<PATH>'

Estimated roll phase dataset

settings.cycle_duration = 20.86455

Duration of a cycle.

settings.delta_ac = 2.0

Distance, in km, between two points across track direction.

settings.delta_al = 2.0

Distance, in km, between two points along track direction.

settings.ephemeris = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/swot-simulator/conda/stable/lib/python3.9/site-packages/swot_simulator-1.2.4-py3.9.egg/swot_simulator/data/ephemeris_science_sept2015_ell.txt')

Ephemeris file to read containing the satellite’s orbit.

settings.ephemeris_cols = [1, 2, 0]

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]`

settings.error_spectrum = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/swot-simulator/conda/stable/lib/python3.9/site-packages/swot_simulator-1.2.4-py3.9.egg/swot_simulator/data/error_spectrum.nc')

File containing spectrum of instrument error

settings.half_gap = 2.0

Distance, in km, between the nadir and the center of the first pixel of the swath

settings.half_swath = 70.0

Distance, in km, between the nadir and the center of the last pixel of the swath

settings.height = 891000

Satellite altitude (m)

settings.karin_noise = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/swot-simulator/conda/stable/lib/python3.9/site-packages/swot_simulator-1.2.4-py3.9.egg/swot_simulator/data/karin_noise_v2.nc')

KaRIN file containing spectrum for several SWH

settings.len_repeat = 20000

repeat length

settings.nadir = False

True to generate Nadir products

settings.nbeam = 2

Number of beam used to correct wet troposphere signal (1, 2 or ‘both’)

settings.noise = ['altimeter', 'baseline_dilation', 'karin', 'orbital', 'roll_phase', 'timing', 'wet_troposphere']

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.

settings.nseed = 0

Seed for RandomState. Must be convertible to 32 bit unsigned integers.

settings.product_type = 'expert'

Type of SWOT product to be generated. Possible products are “basic”, “expert”, “unsmoothed” and “wind_wave”. Defaul to expert

settings.requirement_bounds = [10, 60]

Limits of SWOT swath requirements. Measurements outside the span will be set with fill values.

settings.shift_lon = 0

Orbit shift in longitude (degrees)

settings.shift_time = 0

Orbit shift in time (seconds)

settings.sigma = 6.0

Gaussian footprint of sigma km

settings.ssh_plugin = None

The plug-in handling the SSH interpolation under the satellite swath.

ssh_plugin = swot_simulator.plugins.ssh.AVISO("PATH to AVISO files")

settings.swath = True

True to generate swath products

settings.swh = 2.0

SWH for the region

settings.swh_plugin = None

SWH plugin to interpolate model SWH on the SWOT grid:

swh_plugin = swot_simulator.plugins.ssh.WW3("PATH to WW3 files")

settings.working_directory = '/home/docs/'

The working directory. By default, files are generated in the user’s root directory.