Skip to content

Latest commit

 

History

History
122 lines (72 loc) · 2.4 KB

GLOSSARY.rst

File metadata and controls

122 lines (72 loc) · 2.4 KB

arkimaps glossary

Arkimaps processing uses terminology taken from a metaphore of cooking.

While the cooking metaphore makes the terminology mostly intuitive, it might be useful to have exact definitions of the terms used by arkimaps in the context of arkimaps.

Those are provided in this file.

Flavor

A named set of default arguments for recipe steps.

Specifying different sets of default arguments can be useful for rendering the same recipes, for example, on different areas, or with different branding or graphic layouts.

Input

Input data (usually in GRIB format) that can be used by a recipe step.

Mixer

A repository of recipe steps that can be executed by a recipe.

It is defined in arkimaps' code. Currently only one mixer is provided called default, in arkimapslib/mixers.py.

Model step

A step in the output of a forecast model, defined in hours from the reference time of a model run.

Order

An order is a collection of all the data needed to generate one single product.

Typically, for each recipe there is an order for each model step for which all required input data are available.

Pantry

Repository of input data available to recipe steps.

Product

An image file produced by a recipe.

Recipe

Defines what is needed to turn inputs into a product.

It can contain:

To allow to define only once some elements common to multiple recipes, there can be recipes that only define inputs or flavours for reuse by other recipes, but provide no sequence of steps themselves.

Recipe step

One processing element on a recipe. Each step has a name and optional arguments.

The set of available step names are defined by the mixer used for processing.

Arguments for steps that are not explicitly provided by recipes can be provided by flavors.