Skip to content

data.RandomDataFrame

Import path: earth2studio.data.RandomDataFrame

View source on GitHub

Documentation

A randomly generated DataFrame source. Primarily useful for testing.

Generates random observations at random locations for specified times and variables. Each observation is a point in space-time with a random value.

Parameters:

  • n_obs (int, default: 10 ) –

    Number of random observations to generate per time step, by default 10

  • tolerance (timedelta | timedelta64, default: timedelta64(0) ) –

    Time tolerance; observations will be randomly sampled within +/- tolerance of each requested time, by default np.timedelta64(0)

  • schema (Schema | None, default: None ) –

    PyArrow schema to use for data generation. If None, uses default SCHEMA. Data will be generated dynamically based on schema field types, by default None

  • field_generators (dict[str, Callable[[], Any]] | None, default: None ) –

    Dictionary mapping field names to generator functions. These will be merged with the default generators. Default generators include: time, lat, lon, observation, variable. User-provided generators will override defaults, by default None

__call__ 

__call__(
    time: datetime | list[datetime] | TimeArray,
    variable: str | list[str] | VariableArray,
    fields: (
        str | list[str] | Schema | FieldArray | None
    ) = None,
) -> DataFrame

Retrieve random observation DataFrame.

Parameters:

  • time (datetime | list[datetime] | TimeArray) –

    Timestamps to return data for.

  • variable (str | list[str] | VariableArray) –

    Strings or list of strings that refer to variables to return.

  • fields (str | list[str] | Schema | FieldArray | None, default: None ) –

    Fields to include in output, by default None (all fields).

Returns:

  • DataFrame –

    Random observation DataFrame