|
383 | 383 | .. _pygithub: https://pygithub.readthedocs.io/en/latest/introduction.html |
384 | 384 |
|
385 | 385 |
|
386 | | -Recipe filler |
387 | | -============= |
388 | | - |
389 | | -If you need to fill in a blank recipe with additional datasets, you can do that with |
390 | | -the command `recipe_filler`. This runs a tool to obtain a set of additional datasets when |
391 | | -given a blank recipe, and you can give an arbitrary number of data parameters. The blank recipe |
392 | | -should contain, to the very least, a list of diagnostics, each with their variable(s). |
393 | | -Example of running the tool: |
394 | | - |
395 | | -.. code-block:: bash |
396 | | -
|
397 | | - recipe_filler recipe.yml |
398 | | -
|
399 | | -where `recipe.yml` is the recipe that needs to be filled with additional datasets; a minimal |
400 | | -example of this recipe could be: |
401 | | - |
402 | | -.. code-block:: yaml |
403 | | -
|
404 | | - diagnostics: |
405 | | - diagnostic: |
406 | | - variables: |
407 | | - ta: |
408 | | - mip: Amon # required |
409 | | - start_year: 1850 # required |
410 | | - end_year: 1900 # required |
411 | | -
|
412 | | -
|
413 | | -Key features |
414 | | ------------- |
415 | | - |
416 | | -- you can add as many variable parameters as are needed; if not added, the |
417 | | - tool will use the ``"*"`` wildcard and find all available combinations; |
418 | | -- you can restrict the number of datasets to be looked for with the ``dataset:`` |
419 | | - key for each variable, pass a list of datasets as value, e.g. |
420 | | - ``dataset: [MPI-ESM1-2-LR, MPI-ESM-LR]``; |
421 | | -- you can specify a pair of experiments, e.g. ``exp: [historical, rcp85]`` |
422 | | - for each variable; this will look for each available dataset per experiment |
423 | | - and assemble an aggregated data stretch from each experiment to complete |
424 | | - for the total data length specified by ``start_year`` and ``end_year``; equivalent to |
425 | | - ESMValTool's syntax on multiple experiments; this option needs an ensemble |
426 | | - to be declared explicitly; it will return no entry if there are gaps in data; |
427 | | -- ``start_year`` and ``end_year`` are required and are used to filter out the |
428 | | - datasets that don't have data in the interval; as noted above, the tool will not |
429 | | - return datasets with partial coverage from ``start_year`` to ``end_year``; |
430 | | - if you want all possible years hence no filtering on years just use ``"*"`` |
431 | | - for start and end years; |
432 | | -- ``config-user: rootpath: CMIPX`` may be a list, rootpath lists are supported; |
433 | | -- all major DRS paths (including ``default``, ``BADC``, ``ETHZ`` etc) are supported; |
434 | | -- speedup is achieved through CMIP mip tables lookup, so ``mip`` is required in recipe; |
435 | | - |
436 | | -Caveats |
437 | | -------- |
438 | | - |
439 | | -- the tool doesn't yet work with derived variables; it will not return any available datasets; |
440 | | -- operation restricted to CMIP data only, OBS lookup is not available yet. |
441 | | - |
442 | | - |
443 | 386 | Extracting a list of input files from the provenance |
444 | 387 | ==================================================== |
445 | 388 |
|
|
0 commit comments