:py:mod:`synthpic2`
===================

.. py:module:: synthpic2

.. autoapi-nested-parse::

   Main synthpic2 module.



Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   blender/index.rst
   recipe/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   custom_types/index.rst
   engine/index.rst
   errors/index.rst
   prototype_library/index.rst
   utilities/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   synthpic2.PrototypeLibrary
   synthpic2.Recipe



Functions
~~~~~~~~~

.. autoapisummary::

   synthpic2.execute_recipe



.. py:function:: execute_recipe(recipe: synthpic2.recipe.Recipe) -> None


.. py:class:: PrototypeLibrary


   A library to load prototypes.

   .. py:attribute:: root

      

   .. py:method:: load() -> None
      :classmethod:


   .. py:method:: load_prototypes(subfolder_name: str, prototype_type: Type[synthpic2.recipe.prototypes.prototypes._Prototype]) -> None
      :classmethod:



.. py:class:: Recipe


   Definition of the structure of the Recipe class.

   .. py:property:: md5
      :type: str


   .. py:attribute:: _target_
      :type: str
      :value: 'synthpic2.Recipe'

      

   .. py:attribute:: _convert_
      :type: str
      :value: 'all'

      

   .. py:attribute:: defaults
      :type: List[Any]

      

   .. py:attribute:: hydra
      :type: Any

      

   .. py:attribute:: initial_runtime_state
      :type: synthpic2.recipe.synth_chain.state.RuntimeState

      

   .. py:attribute:: blueprints
      :type: Blueprints

      

   .. py:attribute:: process_conditions
      :type: ProcessConditions

      

   .. py:attribute:: synth_chain
      :type: synthpic2.recipe.synth_chain.SynthChain

      

   .. py:method:: execute() -> None