Skip to content

Commit

Permalink
more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
b8raoult committed Mar 26, 2024
1 parent a0ec010 commit 87f5e37
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/building/sources/constants.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,23 @@
Although this source is called `constants`, its purpose is to provide
fields with values that only depend on the grid cell and/or the time.

Because the source needs to generate fields on the same grids as the
other, it requires a template field. This is provided in the recipe with
the `template` keyword:

.. literalinclude:: constants.yaml
:language: yaml

The value ``${input.join.0.source1}`` is the "path" to the first source,
starting from the root of the recipe. The path is composed of the of the
nodes in the recipe, separated by dots. If a node contains a list, the
index of the next node is added after the node name, starting from 0.

The is a mean to provide the model with with space and time information
during training and inference.

The following fields are available:

latitude
Each grid point has the value of its latitude in degrees.

Expand Down
12 changes: 12 additions & 0 deletions docs/building/sources/constants.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
input:
join:
- source1:
args1: value1
args2: value2

- constants:
template: ${input.join.0.source1}
params:
- insolation
- cos_julian_day
- sin_julian_day

0 comments on commit 87f5e37

Please sign in to comment.