dummy/std dummy/std

Description

This toy model is implemented in the CIF as a testing utility. It can easily be run on office laptop with low computational requirements. Thus, features in pycif can be explored quickly.

It is also proposed as a minimal example of a fully implemented model in pycif. We recommend developers to explore its code as a template for new model implementation in pycif.

Gaussian plume equation

The Toy Gaussian Model follows the standard version of the Gaussian plume equation based on Pasquill-Gifford stability classification:

(1)\[\frac{1}{2 \, \pi \;.\;\sigma_y \;.\; \sigma_z \;.\;\bar{u}} \exp\left(-\,\dfrac{y^2}{\sigma_y ^2}\right) \exp\left(-\,\dfrac{z^2}{\sigma_z ^2}\right)\]

with

(2)\[\begin{split}\left\{ \begin{array}{rcl} \sigma_z &=& a\;.\;x^b \\ \sigma_y &=& | 465.11628 \;x\;.\; \tan(0.017653293 (c - d \;\ln x)) | \end{array} \right.\end{split}\]

x is the distance between the source and receptor points, (a, b, c, d) are parameters depending on the stability class.

Parameter values

The Gaussian plume model as implemented in pycif is based on the U.S. E.P.A. model ISC3 (Industrial Source Complex). The model is described in the report EPA-454/B-95-003b of September 1995. The parameter values are given in Section 1.1.5 from page 1-15 to 1-19.

YAML arguments

The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:

Mandatory arguments

file_pg : str, mandatory

file with Pasquill-Gifford stability classes. Give correspondences between stability classes and gaussian dispersion parameters. The file is provided alongside pyCIF sources in the directory: ${CIF_root}/model_sources/dummy_gauss/

Optional arguments

autoflush : bool, optional, default False

Cleans big temporary files when the simulation is done. Triggers the function flushrun of the model if available

periods : str, optional, default “1D”

length of simulation sub-periods

tstep : str, optional, default “1h”

length of simulation temproal steps

save_H : bool, optional, default False

save the sensitivity matrix to a pickle file

reload_H : str, optional, default “”

Load the sensitivity matrix from the given pickle file

Requirements

The current plugin requires the present plugins to run properly:

Requirement name	Requirement type	Explicit definition	Any valid	Default name	Default version
domain	Domain	False	False	dummy	std
flux	DataStream	True	False	dummy	nc
meteo	DataStream	True	False	dummy	csv

YAML template

Please find below a template for a YAML configuration:

model:
  plugin:
    name: dummy
    version: std
    type: model

  # Mandatory arguments
  file_pg: XXXXX  # str

  # Optional arguments
  autoflush: XXXXX  # bool
  periods: XXXXX  # str
  tstep: XXXXX  # str
  save_H: XXXXX  # bool
  reload_H: XXXXX  # str