flexpart_release

../../_images/FLEXPART_RELEASE.png

Defines release conditions for running the FLEXPART Lagrangian particle dispersion model via flexpart_run().

Note

This function performs the same task as the Flexpart Release icon in Metview’s user interface. It accepts its parameters as keyword arguments, described below.

flexpart_release(**kwargs)

Defines release conditions for flexpart_run().

Parameters

  • name (str) – Specifies the name of the release (maximum 40 characters).

  • starting_date (str, default: "0") – Specifies the beginning date of the release in YYYYMMDD format. Relative dates with respect to the run date of the FLEXPART simulation (see parameter starting_date in flexpart_run()) are allowed: e.g. 0 means run date, 1 means the day after the run date, etc.

  • starting_time (str) – Specifies the beginning time of the release in HH[:MM[:SS]] format.

  • ending_date (str, default: "0") – Specifies the ending date of the release in YYYYMMDD format. Relative dates with respect to the run date of the FLEXPART simulation (see parameter starting_date in flexpart_run()) are allowed: e.g. 0 means run date, 1 means the day after the run date, etc.

  • ending_time (str) – Specifies the ending time of the release in HH[:MM[:SS]] format.

  • area (list[number], default: [-90, -180, 90, 180]) – Specifies the area for the release in degrees in S/W/N/E format.

  • level_units ({"agl", "asl", "hpa"}, default: "agl") –

    Specifies the units for the release vertical extent. The possible values are:

    • ”agl”: metres above ground level

    • ”asl”: metres above sea level

    • ”hpa”: pressure in hPa

  • top_level (number) – Specifies the top level of the release.

  • bottom_level (number) – Specifies the bottom level of the release.

  • particle_count (number) – Specifies the number of particles released.

  • masses (number or list[number]) – Specifies the list of total masses of the released species. The number of masses given here must match the number of species defined via the release_species parameter of flexpart_run(). The actual units of masses is defined by the release_units parameter of flexpart_run(). Please note that for backward simulations any non-zero positive value can stand here because the output is normalised by this value!

Return type

Request