opendrift.readers

Readers are responsible for providing Opendrift with data about the enviornment of the drifting particles or elements.

All readers descend from basereader.BaseReader. A reader generally also descends from one of the few general classes of readers. When writing a new reader consider which one fits your input data best:

• basereader.continuous.ContinuousReader

• basereader.structured.StructuredReader

• basereader.unstructured.UnstructuredReader

The ContinuousReader is suited for data that can be defined at any point within the domain, or if the reader does its own interpolation internally. E.g. a synthetic eddy, or a constant. The StructuredReader aids in interpolation when creating a reader of data on a regular grid, while the UnstructuredReader provides the basics for irregularily gridded data (e.g. finite volume models).

See also

See the reader-types or reader-implementations for more details.

See basereader.BaseReader for how readers work internally.

Submodules

• opendrift.readers.basereader
• opendrift.readers.interpolation
• opendrift.readers.operators
• opendrift.readers.reader_ArtificialOceanEddy
• opendrift.readers.reader_ROMS_native
• opendrift.readers.reader_constant
• opendrift.readers.reader_constant_2d
• opendrift.readers.reader_copernicusmarine
• opendrift.readers.reader_current_from_drifter
• opendrift.readers.reader_current_from_track
• opendrift.readers.reader_double_gyre
• opendrift.readers.reader_failing
• opendrift.readers.reader_global_landmask
• opendrift.readers.reader_grib
• opendrift.readers.reader_grib2
• opendrift.readers.reader_lazy
• opendrift.readers.reader_netCDF_CF_generic
• opendrift.readers.reader_netCDF_CF_unstructured
• opendrift.readers.reader_oscillating
• opendrift.readers.reader_schism_native
• opendrift.readers.reader_shape
• opendrift.readers.reader_telemac_selafin
• opendrift.readers.reader_timeseries
• opendrift.readers.roppy

Attributes

logger

Functions

open_dataset_opendrift(source[, zarr_storage_options, ...])	Wrapper around Xarray open_dataset and open_mfdataset.
datetime_from_variable(var)
open_mfdataset_overlap(url_base[, time_series, ...])
applicable_readers(url)	Return a list of readers that are possible candidates for a given URL, filename or product ID
reader_from_url(url[, timeout])	Make readers from URLs or paths to datasets

Package Contents

opendrift.readers.logger

opendrift.readers.open_dataset_opendrift(source, zarr_storage_options=None, open_mfdataset_options={})

Wrapper around Xarray open_dataset and open_mfdataset.

Common wrapper/opener to be used for all Xarray based readers

xarray.open_dataset will be used if source is:

• a single netCDF file or OPeNDAP URL

xarray.open_mfdataset will be used if source is:

• a list of netCDF files

• a filename with wildcards (* ? or [)

cf-times are decoded after removing any offending variables

(e.g. if units equals “hours since analysis”)

opendrift.readers.datetime_from_variable(var)

opendrift.readers.open_mfdataset_overlap(url_base, time_series=None, start_time=None, end_time=None, freq=None, timedim='time')

opendrift.readers.applicable_readers(url)

Return a list of readers that are possible candidates for a given URL, filename or product ID

opendrift.readers.reader_from_url(url, timeout=10)

Make readers from URLs or paths to datasets