Recipes ========= Schema ------ .. raw:: html

.. raw:: html OpenAPI Docs ------------- You can find the Open API Docs formatted by redoc `here <../_static/redoc-recipe.html#tag/recipe_model>`_. OpenAPI Definition ------------------- You can find the OpenAPI JSON definition `here <../_static/schemas/recipe-openapi.json>`_. JSON Schema Definition ----------------------- You can find the JSON Schema definition `here <../_static/schemas/recipe-schema.json>`_. Examples -------- Minimal ^^^^^^^ The minimal configuration for a recipe can be found below. The keys indicated here are the ones you **absolutely** have to fill in for this recipe to be validated by Queenbee. .. literalinclude:: ../../tests/assets/recipes/valid/minimal.yaml :language: yaml Daylight-Factor Recipe ^^^^^^^^^^^^^^^^^^^^^^ This is an example recipe called ``daylight-factor``. It is used to run a daylight factor simulation and takes a ``model`` and an ``input-grid`` as artifact (file) inputs. A user can also optionally set the ``sensor-grid-count`` and ``radiance-parameters`` parameters. .. note:: The dependencies source is set to a fake domain ``https://example.com/test-repo``. In a real scenario this url would refer to an existing Queenbee package repository. .. literalinclude:: ../../tests/assets/recipes/valid/daylight-factor.yaml :language: yaml