:py:mod:`raesl.canopy`
======================

.. py:module:: raesl.canopy

.. autoapi-nested-parse::

   Module to ESL derived graph to a graph suitable for exporting to Canopy.



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

   html/index.rst


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


Functions
~~~~~~~~~

.. autoapisummary::

   raesl.canopy.get_comp_node_html_table
   raesl.canopy.get_edge_html_text
   raesl.canopy.get_spec_node_html_text
   raesl.canopy.add_canopy_annotations



Attributes
~~~~~~~~~~

.. autoapisummary::

   raesl.canopy.DEFAULT_NODE_KINDS
   raesl.canopy.DEFAULT_EDGE_KINDS


.. py:function:: get_comp_node_html_table(node: ragraph.node.Node, graph: ragraph.graph.Graph, node_kinds: List[str]) -> LineGen

   Returns a HTML grid table.


.. py:function:: get_edge_html_text(h: int, edge: ragraph.edge.Edge, graph: ragraph.graph.Graph) -> LineGen

   Yields ESL info belonging to an edge.


.. py:function:: get_spec_node_html_text(h: int, node: ragraph.node.Node, graph: ragraph.graph.Graph) -> LineGen

   Yields ESL info belonging to spec node in html format.


.. py:data:: DEFAULT_NODE_KINDS
   :value: ['component', 'function_spec', 'behavior_spec', 'design_spec', 'need', 'relation_spec', 'variable']

   

.. py:data:: DEFAULT_EDGE_KINDS
   :value: ['functional_dependency', 'logical_dependency', 'design_dependency', 'coordination_dependency',...

   

.. py:function:: add_canopy_annotations(graph: ragraph.graph.Graph, node_kinds: Optional[List[str]] = None, edge_kinds: Optional[List[str]] = None)

   Convert ESL derived graph to a graph suitable for exporting to Canopy.

   :param graph: Graph to be converted
   :param node_kinds: List of node kinds to be considered in conversion.
   :param edge_kinds: List of edge kinds to be considered in conversion.

   Returns
       Converted graph object.