arlmet.File.add_record#

File.add_record(time, variable, level, *, forecast, data=None, diff=None)[source]#

Add one writable DataRecord, creating its RecordSet if needed.

Shorthand for create_recordset(time) (when time has no record set yet) followed by RecordSet.create_datarecord(). A record set created here derives its index-record forecast from its records; call create_recordset() first to set it explicitly.

Parameters:

  • time (Timestamp | str) – Valid time of the record.

  • variable (str) – Four-character ARL variable name.

  • level (int) – ARL level index for the record.

  • forecast (int) – Forecast hour to write into the record header.

  • data (ArrayLike | None) – (ny, nx) field values. When omitted, assign the whole field later with record[:] = values.

  • diff (str | Sequence[str] | None) – Name of a trailing DIF record to derive from the parent field, or the names of several, written in order. Each must be one HYSPLIT’s name table pairs with variable at level (see RecordSet.create_datarecord()).

Returns:

Writable data record for variable at level and time.

Return type:

DataRecord