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:

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

Attributes

logger

Functions

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_mfdataset_overlap(url_base, time_series=None, start_time=None, end_time=None, freq=None, timedim='time')[source]
opendrift.readers.applicable_readers(url)[source]

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)[source]

Make readers from URLs or paths to datasets