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.

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: (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/

accepted type: <class ‘str’>

Optional arguments

autoflush: (optional): False

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

accepted type: <class ‘bool’>

periods: (optional): 1D

length of simulation sub-periods

accepted type: <class ‘str’>

tstep: (optional): 1H

length of simulation temproal steps

accepted type: <class ‘str’>

save_H: (optional): False

save the sensitivity matrix to a pickle file

accepted type: <class ‘bool’>

reload_H: (optional):

Load the sensitivity matrix from the given pickle file

accepted type: <class ‘str’>

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:

 1model:
 2  plugin:
 3    name: dummy
 4    version: std
 5    type: model
 6
 7  # Mandatory arguments
 8  file_pg: XXXXX
 9
10  # Optional arguments
11  autoflush: XXXXX
12  periods: XXXXX
13  tstep: XXXXX
14  save_H: XXXXX
15  reload_H: XXXXX