paroto.io.stone
===============

.. py:module:: paroto.io.stone

.. autoapi-nested-parse::

   STONE format YAML serialization for architecture definition.

   STONE (Structured Topology for Optimization and aNalysis Environments) format
   provides a standardized way to serialize optimization architectures.



Functions
---------

.. autoapisummary::

   paroto.io.stone.serialize_architecture_to_stone
   paroto.io.stone.load_architecture_from_stone
   paroto.io.stone.create_architecture_yaml


Module Contents
---------------

.. py:function:: serialize_architecture_to_stone(prob, output_path)

   Serialize OpenMDAO problem architecture to STONE format YAML.

   :param prob: OpenMDAO problem instance
   :type prob: :py:class:`om.Problem`
   :param output_path: Path to output YAML file
   :type output_path: :py:class:`str`


.. py:function:: load_architecture_from_stone(yaml_path)

   Load architecture from STONE format YAML file.

   :param yaml_path: Path to YAML file
   :type yaml_path: :py:class:`str`

   :returns: **architecture** -- Architecture dictionary
   :rtype: :py:class:`dict`


.. py:function:: create_architecture_yaml(name, components, connections = None, output_path = None)

   Create a STONE format architecture definition.

   :param name: Architecture name
   :type name: :py:class:`str`
   :param components: List of component definitions
   :type components: :py:class:`list`
   :param connections: List of connections
   :type connections: :py:class:`list`, *optional*
   :param output_path: If provided, save to this path
   :type output_path: :py:class:`str`, *optional*

   :returns: **architecture** -- Architecture dictionary
   :rtype: :py:class:`dict`