From f1e5e80cc196cfbd49fedff647e6a55e68c08ead Mon Sep 17 00:00:00 2001
From: maaikedieuwertje <maaikedieuwertje@gmail.com>
Date: Sat, 21 Apr 2018 11:16:55 +0200
Subject: [PATCH] Improved/extended documentation of cmdows and utilities up
 until general

Former-commit-id: 701a0d450a939a6ff9c7c40a4fd4986374b8e5b7
---
 doc/KADMOS.html             | 524 +++++++++++++++++++++++++++++++++---
 doc/genindex.html           |   8 +-
 doc/objects.inv             | Bin 2356 -> 2365 bytes
 doc/searchindex.js          |   2 +-
 kadmos/cmdows/cmdows.py     | 216 +++++++++++++--
 kadmos/utilities/general.py | 122 ++++++---
 6 files changed, 778 insertions(+), 94 deletions(-)

diff --git a/doc/KADMOS.html b/doc/KADMOS.html
index 818d9bf3c..47d0aa2c4 100644
--- a/doc/KADMOS.html
+++ b/doc/KADMOS.html
@@ -1870,7 +1870,7 @@ deleted. A simple remove_node of a function node might lead to unconnected varia
 
 <dl class="method">
 <dt id="kadmos.graph.graph_kadmos.KadmosGraph.save">
-<code class="descname">save</code><span class="sig-paren">(</span><em>file_name</em>, <em>file_type='kdms'</em>, <em>graph_check_critical=True</em>, <em>destination_folder=None</em>, <em>mpg=None</em>, <em>description=''</em>, <em>creator=''</em>, <em>version='1.0'</em>, <em>timestamp=datetime.datetime(2018</em>, <em>4</em>, <em>13</em>, <em>10</em>, <em>36</em>, <em>45</em>, <em>941000)</em>, <em>keep_empty_elements=False</em>, <em>pretty_print=False</em>, <em>convention=True</em>, <em>integrity=False</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.graph.graph_kadmos.KadmosGraph.save" title="Permalink to this definition">¶</a></dt>
+<code class="descname">save</code><span class="sig-paren">(</span><em>file_name</em>, <em>file_type='kdms'</em>, <em>graph_check_critical=True</em>, <em>destination_folder=None</em>, <em>mpg=None</em>, <em>description=''</em>, <em>creator=''</em>, <em>version='1.0'</em>, <em>timestamp=datetime.datetime(2018</em>, <em>4</em>, <em>21</em>, <em>11</em>, <em>14</em>, <em>14</em>, <em>243000)</em>, <em>keep_empty_elements=False</em>, <em>pretty_print=False</em>, <em>convention=True</em>, <em>integrity=False</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.graph.graph_kadmos.KadmosGraph.save" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to save the graph.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -3563,6 +3563,35 @@ architectures for the same problem in one VISTOMS instance.</p>
 <dt id="kadmos.cmdows.cmdows.CMDOWS.add_actor">
 <code class="descname">add_actor</code><span class="sig-paren">(</span><em>contact_uid</em>, <em>role</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.add_actor" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to add a role element to the organization branch.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>contact_uid</strong> (<em>basestring</em>) – uID of the contact</li>
+<li><strong>role</strong> (<em>str</em>) – contact role</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">enriched organizational branch</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">XMLSchema</p>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p>Role options are:</p>
+<ul class="last simple">
+<li>‘architect’</li>
+<li>‘integrator’</li>
+<li>‘collaborative_engineer’</li>
+<li>‘tool_specialist’</li>
+<li>‘customer’</li>
+</ul>
+</div>
 </dd></dl>
 
 <dl class="method">
@@ -3843,6 +3872,42 @@ architectures for the same problem in one VISTOMS instance.</p>
 <dt id="kadmos.cmdows.cmdows.CMDOWS.add_new_parameters_from_element">
 <code class="descname">add_new_parameters_from_element</code><span class="sig-paren">(</span><em>parameters_element</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.add_new_parameters_from_element" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to add the new parameters based on a parameters element.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parameters_element</strong> (<em>element</em>) – new parameters</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">enriched parameters branch</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="kadmos.cmdows.cmdows.CMDOWS.add_subelement">
+<code class="descname">add_subelement</code><span class="sig-paren">(</span><em>element</em>, <em>subelement_xpath_tag</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.add_subelement" title="Permalink to this definition">¶</a></dt>
+<dd><p>Method to add a subelement to an existing element.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>element</strong> (<em>element</em>) – element to be added to</li>
+<li><strong>subelement_xpath_tag</strong> (<em>xpath/tag</em>) – subelement to be added.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">enriched element branch</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">XMLSchema</p>
+</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
@@ -3934,6 +3999,18 @@ architectures for the same problem in one VISTOMS instance.</p>
 <dt id="kadmos.cmdows.cmdows.CMDOWS.ensure_abs_xpath">
 <code class="descname">ensure_abs_xpath</code><span class="sig-paren">(</span><em>xpath</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.ensure_abs_xpath" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to ensure that the elements given by an absolute XPath exist.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>xpath</strong> (<em>basestring</em>) – XPath to be checked</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">checked XPath</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">basestring</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
@@ -4100,82 +4177,303 @@ architectures for the same problem in one VISTOMS instance.</p>
 </table>
 </dd></dl>
 
+<dl class="method">
+<dt id="kadmos.cmdows.cmdows.CMDOWS.remove_actor">
+<code class="descname">remove_actor</code><span class="sig-paren">(</span><em>role</em>, <em>uid</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_actor" title="Permalink to this definition">¶</a></dt>
+<dd><p>Method to remove a role from the organization for a certain contact.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>role</strong> (<em>str</em>) – role to be removed from contact</li>
+<li><strong>uid</strong> (<em>basestring</em>) – uID of contact</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Organization branch without contact role</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">XMLSchema</p>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p>Role options are:</p>
+<ul class="last simple">
+<li>‘architect’</li>
+<li>‘integrator’</li>
+<li>‘collaborativeEngineer’</li>
+<li>‘toolSpecialist’</li>
+<li>‘customer’</li>
+</ul>
+</div>
+</dd></dl>
+
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_children_of_uid">
 <code class="descname">remove_children_of_uid</code><span class="sig-paren">(</span><em>uid</em>, <em>children_to_remove='__all__'</em>, <em>children_to_keep='__none__'</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_children_of_uid" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to remove the children of a CMDOWS file element based on a UID.</p>
+<dd><p>Method to remove the children of a CMDOWS file element based on a uID.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>uid</strong> (<em>basestring</em>) – uID of the element to remove the children of</li>
+<li><strong>children_to_remove</strong> (<em>element</em>) – (optional) list of children to be removed (default: remove all)</li>
+<li><strong>children_to_keep</strong> (<em>element</em>) – (optional) list of children to be kept (default: keep none)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">element with (certain) children removed</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">XMLSchema</p>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition attention">
+<p class="first admonition-title">Attention</p>
+<p class="last">make sure the child elements contained in the two lists do not overlap.</p>
+</div>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_children_of_xpath">
 <code class="descname">remove_children_of_xpath</code><span class="sig-paren">(</span><em>xpath</em>, <em>children_to_remove='__all__'</em>, <em>children_to_keep='__none__'</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_children_of_xpath" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to remove the children of a CMDOWS file element based on an XPath.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>xpath</strong> (<em>basestring</em>) – XPath of the element to remove the children of</li>
+<li><strong>children_to_remove</strong> (<em>element</em>) – (optional) list of children to be removed (default: remove all)</li>
+<li><strong>children_to_keep</strong> (<em>element</em>) – (optional) list of children to be kept (default: keep none)</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">element with (certain) children removed</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">XMLSchema</p>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition attention">
+<p class="first admonition-title">Attention</p>
+<p class="last">make sure the child elements contained in the two lists do not overlap.</p>
+</div>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_contact">
 <code class="descname">remove_contact</code><span class="sig-paren">(</span><em>contact_uid</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_contact" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to remove a contact based on its UID.</p>
+<dd><p>Method to remove a contact based on its uID.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>contact_uid</strong> (<em>basestring</em>) – uID of the contact to be removed</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Schema without contact</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_data_graph_element">
 <code class="descname">remove_data_graph_element</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_data_graph_element" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to remove a dataGraph element from a CMDOWS file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Schema without dataGraph</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_element_based_on_uid">
 <code class="descname">remove_element_based_on_uid</code><span class="sig-paren">(</span><em>uid</em>, <em>expected_tag=None</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_element_based_on_uid" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to remove an element based on its UID.</p>
+<dd><p>Method to remove an element based on its uID.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>uid</strong> (<em>basestring</em>) – uID of element to be removed</li>
+<li><strong>expected_tag</strong> (<em>str</em>) – (optional) the expected tag of the element</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Schema without element</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">XMLSchema</p>
+</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_element_based_on_xpath">
 <code class="descname">remove_element_based_on_xpath</code><span class="sig-paren">(</span><em>xpath</em>, <em>expected_amount=None</em>, <em>expected_text=None</em>, <em>higher_level_removal=None</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_element_based_on_xpath" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to remove an element based on its XPath.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>xpath</strong> (<em>basestring</em>) – XPath of element to be removed</li>
+<li><strong>expected_amount</strong> (<em>int</em>) – (optional) the expected amount of elements with this path</li>
+<li><strong>expected_text</strong> (<em>str</em>) – (optional) the expected text of the element</li>
+<li><strong>higher_level_removal</strong> (<em>int</em>) – (optional) the amount of higher levels to be removed</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Schema without element</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">XMLSchema</p>
+</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_in_and_outputs">
 <code class="descname">remove_in_and_outputs</code><span class="sig-paren">(</span><em>exblock_uid</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_in_and_outputs" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to remove the in- and outputs of a CMDOWS file executableBlock entry</p>
+<dd><p>Method to remove the in- and outputs of a CMDOWS file executableBlock entry.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>exblock_uid</strong> (<em>basestring</em>) – executableBlock to remove the in- and outputs from</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">executableBlock without in- and outputs</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_inputs">
 <code class="descname">remove_inputs</code><span class="sig-paren">(</span><em>exblock_uid</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_inputs" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to remove the inputs of a CMDOWS file executableBlock entry</p>
+<dd><p>Method to remove the inputs of a CMDOWS file executableBlock entry.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>exblock_uid</strong> (<em>basestring</em>) – executableBlock to remove the inputs from</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">executableBlock without inputs</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_outputs">
 <code class="descname">remove_outputs</code><span class="sig-paren">(</span><em>exblock_uid</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_outputs" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to remove the outputs of a CMDOWS file executableBlock entry</p>
+<dd><p>Method to remove the outputs of a CMDOWS file executableBlock entry.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>exblock_uid</strong> (<em>basestring</em>) – executableBlock to remove the outputs from</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">executableBlock without outputs</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_parameter">
 <code class="descname">remove_parameter</code><span class="sig-paren">(</span><em>param_uid</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_parameter" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to remove a parameter based on its UID.</p>
+<dd><p>Method to remove a parameter based on its uID.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>param_uid</strong> (<em>basestring</em>) – uID of parameter to be removed</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Schema without parameter</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_parameters">
 <code class="descname">remove_parameters</code><span class="sig-paren">(</span><em>params_uids</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_parameters" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to remove a list of parameters based on their UID.</p>
+<dd><p>Method to remove a list of parameters based on their uID.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params_uid</strong> – uIDs of parameters to be removed</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Schema without parameters listed</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_parameters_element">
 <code class="descname">remove_parameters_element</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_parameters_element" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to remove a parameters element from a CMDOWS file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Schema without parameters</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_process_graph_element">
 <code class="descname">remove_process_graph_element</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_process_graph_element" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to remove a processGraph element from a CMDOWS file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Schema without processGraph</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
@@ -4198,18 +4496,71 @@ architectures for the same problem in one VISTOMS instance.</p>
 <dt id="kadmos.cmdows.cmdows.CMDOWS.remove_workflow_element">
 <code class="descname">remove_workflow_element</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.remove_workflow_element" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to remove a workflow element from a CMDOWS file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Schema without workflow</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.resolve_uids">
 <code class="descname">resolve_uids</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.resolve_uids" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to rename duplicate UIDs in a CMDOWS file</p>
+<dd><p>Method to rename duplicate uIDs in a CMDOWS file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">renamed duplicate uIDs</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">XMLSchema</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="method">
 <dt id="kadmos.cmdows.cmdows.CMDOWS.save">
 <code class="descname">save</code><span class="sig-paren">(</span><em>file_path=None</em>, <em>pretty_print=False</em>, <em>method='xml'</em>, <em>xml_declaration=True</em>, <em>encoding='UTF-8'</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.cmdows.cmdows.CMDOWS.save" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to save a manipulated CMDOWS file</p>
+<dd><p>Method to save a manipulated CMDOWS file.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>file_path</strong> (<em>basestring</em>) – file path of the CMDOWS</li>
+<li><strong>pretty_print</strong> (<em>bool</em>) – (optional)</li>
+<li><strong>method</strong> (<em>str</em>) – (optional) output method (see options below, default: “xml”)</li>
+<li><strong>xml_declaration</strong> (<em>bool</em>) – (optional) addition of XML declaration to file</li>
+<li><strong>encoding</strong> (<em>str</em>) – (optional) output encoding (see options below, default: “UTF-8”)</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p>Output method options:</p>
+<ul class="last simple">
+<li>“xml”</li>
+<li>“html”</li>
+<li>“text”</li>
+<li>“c14n”</li>
+</ul>
+</div>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p>Output encoding options:</p>
+<ul class="last simple">
+<li>“UTF-8”</li>
+<li>“US-ASCII”</li>
+</ul>
+</div>
 </dd></dl>
 
 <dl class="method">
@@ -4278,6 +4629,22 @@ architectures for the same problem in one VISTOMS instance.</p>
 <dt id="kadmos.utilities.general.assert_dict_keys">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">assert_dict_keys</code><span class="sig-paren">(</span><em>dic</em>, <em>expected_keys</em>, <em>all_keys_required=False</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.assert_dict_keys" title="Permalink to this definition">¶</a></dt>
 <dd><p>Method to assert that a dictionary has the expected keys and (optionally) to check if is has all the keys.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>dic</strong> (<em>dict</em>) – dictionary to checked</li>
+<li><strong>expected_keys</strong> (<em>list</em>) – keys expected in dictionary</li>
+<li><strong>all_keys_required</strong> (<em>bool</em>) – (optional) to check if all keys are in the dictionary</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">check results</p>
+</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="function">
@@ -4297,14 +4664,48 @@ architectures for the same problem in one VISTOMS instance.</p>
 <dl class="function">
 <dt id="kadmos.utilities.general.convert_bytes">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">convert_bytes</code><span class="sig-paren">(</span><em>num</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.convert_bytes" title="Permalink to this definition">¶</a></dt>
-<dd><p>this function will convert bytes to MB…. GB… etc</p>
+<dd><p>Function to convert bytes to  KB, MB, GB, TB.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>num</strong> (<em>int</em>) – number of bytes</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">converted number</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="function">
 <dt id="kadmos.utilities.general.dict_to_ord_dict">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">dict_to_ord_dict</code><span class="sig-paren">(</span><em>dic</em>, <em>key_order</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.dict_to_ord_dict" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to transform a Python dictionary into a Python ordered dictionary. Note that the key_order list can have
-items that are not present in the given dictionary. All keys of the dictionary should be in the order though.</p>
+<dd><p>Method to transform a Python dictionary into a Python ordered dictionary.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>dic</strong> (<em>dict</em>) – dictionary</li>
+<li><strong>key_order</strong> (<em>list</em>) – order of the keys</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">ordered dictionary</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">OrderedDict</p>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">the key_order list can have items that are not present in the given dictionary. All keys of the
+dictionary should be in the order though.</p>
+</div>
 </dd></dl>
 
 <dl class="function">
@@ -4337,34 +4738,58 @@ items that are not present in the given dictionary. All keys of the dictionary s
 <dl class="function">
 <dt id="kadmos.utilities.general.file_size">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">file_size</code><span class="sig-paren">(</span><em>file_path</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.file_size" title="Permalink to this definition">¶</a></dt>
-<dd><p>this function will return the file size</p>
+<dd><p>Function to return the file size.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file_path</strong> (<em>str</em>) – file path</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">file size</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="function">
 <dt id="kadmos.utilities.general.file_size_MB">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">file_size_MB</code><span class="sig-paren">(</span><em>file_path</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.file_size_MB" title="Permalink to this definition">¶</a></dt>
-<dd><p>this function will return the file size</p>
+<dd><p>Function to return the file size in MB.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file_path</strong> (<em>str</em>) – file path</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">file size in MB</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">float</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="function">
 <dt id="kadmos.utilities.general.filter_group_vars">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">filter_group_vars</code><span class="sig-paren">(</span><em>group_dict</em>, <em>current_group_idx</em>, <em>filter_setting</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.filter_group_vars" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to get the variables of a local group.</p>
+<dd><p>Method to get the variables of a local/external group.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>group_dict</strong> – </li>
-<li><strong>group_idx</strong> – </li>
-<li><strong>filter_setting</strong> – </li>
+<li><strong>group_dict</strong> (<em>dict</em>) – local/external group</li>
+<li><strong>current_group_idx</strong> (<em>int</em>) – index of the current group</li>
+<li><strong>filter_setting</strong> (<em>list</em><em>, </em><em>string</em>) – filter on ‘local’ or ‘external’ groups</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">group variables</p>
 </td>
 </tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"></p>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
 </td>
 </tr>
 </tbody>
@@ -4447,14 +4872,25 @@ items that are not present in the given dictionary. All keys of the dictionary s
 <dl class="function">
 <dt id="kadmos.utilities.general.get_friendly_id">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">get_friendly_id</code><span class="sig-paren">(</span><em>uid_length</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.get_friendly_id" title="Permalink to this definition">¶</a></dt>
-<dd><p>Create an ID string we can recognise.
-(Think Italian or Japanese or Native American.)</p>
+<dd><p>Create a recognisable ID string.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>uid_length</strong> (<em>int</em>) – length of the ID</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new ID</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="function">
 <dt id="kadmos.utilities.general.get_group_vars">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">get_group_vars</code><span class="sig-paren">(</span><em>sa</em>, <em>current_group_idx</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.get_group_vars" title="Permalink to this definition">¶</a></dt>
-<dd><p>Method to get the variables with respect to t subgroup.</p>
+<dd><p>Method to get the variables with respect to the subgroup.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -4539,6 +4975,24 @@ items that are not present in the given dictionary. All keys of the dictionary s
 <dt id="kadmos.utilities.general.get_unique_friendly_id">
 <code class="descclassname">kadmos.utilities.general.</code><code class="descname">get_unique_friendly_id</code><span class="sig-paren">(</span><em>used_ids</em>, <em>uid_length</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.utilities.general.get_unique_friendly_id" title="Permalink to this definition">¶</a></dt>
 <dd><p>Return an ID that is not in our list of already used IDs.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>used_ids</strong> (<em>list</em>) – already used IDs</li>
+<li><strong>uid_length</strong> (<em>int</em>) – length of the ID</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">new unique ID</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
 <dl class="function">
@@ -4741,12 +5195,15 @@ items that are not present in the given dictionary. All keys of the dictionary s
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>dictionary</strong> – dictionary to be translated</li>
-<li><strong>translations</strong> – dictionary used for the translation</li>
+<li><strong>dictionary</strong> (<em>dict</em>) – dictionary to be translated</li>
+<li><strong>translations</strong> (<em>dict</em>) – dictionary used for the translation</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">translated dictionary</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">translated dictionary</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict</p>
 </td>
 </tr>
 </tbody>
@@ -4762,12 +5219,15 @@ items that are not present in the given dictionary. All keys of the dictionary s
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>l</strong> – list to be translated</li>
-<li><strong>dictionary</strong> – dictionary used for the translation</li>
+<li><strong>l</strong> (<em>list</em>) – list to be translated</li>
+<li><strong>dictionary</strong> (<em>dict</em>) – dictionary used for the translation</li>
 </ul>
 </td>
 </tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">translated list</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">translated list</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list</p>
 </td>
 </tr>
 </tbody>
@@ -4784,7 +5244,7 @@ items that are not present in the given dictionary. All keys of the dictionary s
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>string</strong> (<em>str</em>) – camelCase string</li>
-<li><strong>separator</strong> – symbol/symbols used as separator</li>
+<li><strong>separator</strong> (<em>str</em>) – symbol/symbols used as separator</li>
 </ul>
 </td>
 </tr>
diff --git a/doc/genindex.html b/doc/genindex.html
index 72b0451e8..78e7bdc9b 100644
--- a/doc/genindex.html
+++ b/doc/genindex.html
@@ -105,10 +105,10 @@
 </li>
       <li><a href="KADMOS.html#kadmos.graph.graph_kadmos.KadmosGraph.add_default_name">add_default_name() (kadmos.graph.graph_kadmos.KadmosGraph method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="KADMOS.html#kadmos.graph.graph_kadmos.KadmosGraph.add_edge">add_edge() (kadmos.graph.graph_kadmos.KadmosGraph method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="KADMOS.html#kadmos.cmdows.cmdows.CMDOWS.add_element_to_element_of_uid">add_element_to_element_of_uid() (kadmos.cmdows.cmdows.CMDOWS method)</a>
 </li>
       <li><a href="KADMOS.html#kadmos.graph.mixin_equation.EquationMixin.add_equation">add_equation() (kadmos.graph.mixin_equation.EquationMixin method)</a>
@@ -138,6 +138,8 @@
       <li><a href="KADMOS.html#kadmos.utilities.xml.ExtendedElement.add_process_hierarchy">add_process_hierarchy() (kadmos.utilities.xml.ExtendedElement method)</a>
 </li>
       <li><a href="KADMOS.html#kadmos.graph.graph_process.MdaoProcessGraph.add_process_partitions">add_process_partitions() (kadmos.graph.graph_process.MdaoProcessGraph method)</a>
+</li>
+      <li><a href="KADMOS.html#kadmos.cmdows.cmdows.CMDOWS.add_subelement">add_subelement() (kadmos.cmdows.cmdows.CMDOWS method)</a>
 </li>
       <li><a href="KADMOS.html#kadmos.utilities.general.assert_dict_keys">assert_dict_keys() (in module kadmos.utilities.general)</a>
 </li>
@@ -586,6 +588,8 @@
       <li><a href="KADMOS.html#kadmos.utilities.xml.recursively_unique_attribute">recursively_unique_attribute() (in module kadmos.utilities.xml)</a>
 </li>
       <li><a href="KADMOS.html#kadmos.graph.graph_kadmos.KadmosGraph.relabel_function_nodes">relabel_function_nodes() (kadmos.graph.graph_kadmos.KadmosGraph method)</a>
+</li>
+      <li><a href="KADMOS.html#kadmos.cmdows.cmdows.CMDOWS.remove_actor">remove_actor() (kadmos.cmdows.cmdows.CMDOWS method)</a>
 </li>
       <li><a href="KADMOS.html#kadmos.cmdows.cmdows.CMDOWS.remove_children_of_uid">remove_children_of_uid() (kadmos.cmdows.cmdows.CMDOWS method)</a>
 </li>
diff --git a/doc/objects.inv b/doc/objects.inv
index dc3bd8df38ca36123cc3e6dc8e54fc401aba4bbc..ec589d32f23a7c1f59d5dd166672198a0c9e9861 100644
GIT binary patch
delta 2263
zcmV;|2q^co61@_Tet)<TfbV_^r8ZZqve&(3*G?+snp#&}l|7;$utmWF0U7``l23V!
zyk4FpjUQ6dcr>DbW-cR%5<mPk`VY<7^QJRy)t`RpOfx80{blv(uOFU%|FYisPW_ZF
zzW?*;{kwhq<yv%&d7fT=d;0MEA78@lLUHF-KVRK_=e9L(8h^%xH#W8perK8jf-u@6
zrHavr%G+5B8Z1{#>aD3|N!<_LF;LKft{oUNgQvvxV7JD0Tniu>tcA{az*X#eqp^P^
z&;wYxm4bU|bQLR48uMm)Yqo5VO%-(qyn#BY*YM1GZaD(LI<~c@BUxcLY^pKNf%WI9
z<83iY>_F`6?texB+kyoYS62yg_|ox82#QX5KR~;|0^=LUjy?CgVo(d7HQ;2c<Hkc7
z3iDIfxxggaBN253F?haFz&6T=JwflXUajVIIQ1wA9u<sY+d+$<W(c^WrmhBED28g*
z;Gj7J>v>UdYXu}2jRRCV4;dnMQZ=X`i28JitJ|a_uz%9O$(V+F&RWa+UA3La#BsB4
zcn}ezDQ52nCdm{^&A4vH{Z&t+pb&Lt+L>e^x-K~?N$aga^W<p7chFI_<?U5H>Sts3
zTV<XJy621v{j1Tmjvt`><~m2m$*xy&d#VO7_%=irzI+}q5O6bNfGAw)Z&a4+5BTTr
z;p2?>_J8)x(dY>?;D~g~8X27hZclYxx~8HpV&##5xCLl79NpBpLD(JMPPRL6!SixH
zM2rN;-Z&?NS2#Le%-EU1)EnfE+dbnhXanahm-F`TLqJDF%zpcUTN%9LWvEo0HJh)1
zt8}31<~Jj&yC${l<ad~ay^?orP98ApZ!n#~0DoE=Tokr7cC>$$&_TyptP-5R4Z7jM
zym9r}8l-f^8uA7zW+A4%-KTGuHKj87Rx=|#B(w%KJ6klnjTG_+*K<<W&|E}}t;I`j
z!6r#|^}MD~FJD-sX^cy@XkqaNEpQL4YuZJyJuS8gPB*GIU{07GE^N<2)AO>yMa3;F
zd4Jq6)1uS!sTVpj+ZV11_ME(t$<9WrL5|0e&dWH0V#n|;yc;%5!2#4lavIw>xoaJ@
zNE05d$&w?%$jG>$kho#oik<Yh?1QCU@$+i8qj4u=I}DEn8YYRFNp1#@_HeOr<hJzC
zZNP?n+%&MVMfoS-<V$bt={KWw+;7sKihmuTH*k}MxXd(XZ-u(+De&vtbIxs2SJ4Aq
zzCDG)P`O_oYR^f%U$B|e|78Lv4;e+og+}W_t$Xdoti3SZMryvyGUeSm4eX+^c)a;&
zgZa{@_)@Y-e*`>QZ!n)$7U0}q7L+5*qn4cg&m$LC0nEX}mJcchL&D0wB+9!()_-Vy
zh>*~<RH)LV+YMZaV|fF0_Ex9ejtZ<uS-#SO*m2!LJ}gN4odODvXNqodSV~gk3VCQP
zYCtk@$QF$bE(O%|C&nEWiAcC3D@Y4_mS~mSu-!hM{eG1@T!hMW@|b+N#u1n>47s5X
z<0nMXEHHZXBH8rOQ4MbEITt`=!++OXsWD_wifnm;cf*^nT!0p*!lRU1*o(*}3GB=>
zy&|^a8&Fhufg;-)E5AcSI@7`5vFPw1wkWu~fo-G>k~gITDZ9Lt*7>}AbSCx6iKm>3
z35qNpyl!eP<=mz(QDLBK=_MI9E*AGW#Xw4R!zS;I6Cu`JM5o@CWT)PQqkqmsM+1Nq
zY6iamb%FVv@;}9?zZ+zSem}9F8L?)tf=p_0LeuxviHTbcq_pS!vZxtM&n>=?(Bc<6
z?wAG_(~XpBA##c45{*j_B#DJgq6*nAaTEhphBr9`BA|7A578k!yP5~C=9MDeLjy|T
zg+V16{|oF3{l82rbi`2Jr+-w<3CB&egKq<9FF7qdxo&P^5+Zj-0U_?k#0VukmZlH_
zODjoULH5cl5`{%Bm3Q6SaFk9(vk(I|dYhaJlE}GpYfA57Ql5Vj_5AP>)wDYF@O*g*
zLN2vhKQ-KZPVY<34sKz_vZIo6t~tz#BhH)nF|CvRC+Wd*Z!BE{!GGaX<~bCK_D+*x
zqpI?7^rX~S#t~}APl8ay(m7jR$DPDkwqkc$gdR>@$-tv~_^?=a@+kFG<h}lw-#mrO
zv-jIukaVJwuh8`C3Yk)Fi-8>>`PFCE9_5F!leqpROLTp6kQ&HEuEFbVByWx8s;*0;
z?TgfCR!X@C+##lO>wkZx*OCFhhFIr|=<75TU7C35kYNsTug$XxCov)7c=74e_~}>t
zG-J54S=SlF271s9dU`W6eud4<b}1g??>C9OK-aBkX`#tw71D}9@o+SlsxCtDF-nv&
zvzi;cM4t-RYMsjp9{7I|KioS$9v+^AVS6~mS)3Ho{63&tqJNB?ELj;rA3|3)r<@Eb
zfy8lm6MTX=rcw?Z`%v`H9sBB%W-g&@rNS^;euruRd-}D45grvz#k%N;7td`hHt{(l
z9?!NFD!C&aE^E(H;N>IlHESQWmX)Xz)rqCdRVk)^(xW#XD)MktRzejg)~P!1LtjG~
z>ZWAS^4kCu6MwveW7z7p-INkyvQqF4<9?A%Y%!)+L)OK`2!|UX7=}`aK|9WZ$|wbl
zk5q3N98u<qh0TZHF=Y0Gi7Q@TZ@G3sOQfge(R7;2<G4CxRyz@zG*J~(#hQ{@BYH;F
z7}D@$S(RKzH)SkYdepHPZ_dsR`Za#cN|y9t!ZdKi7=OQHUM`PtA05rHQ>FK<KOTMX
ztDBGKN6_y$@NeF~o*AUvg_LDA-o^?AT-RelIT3e$Zi?tWZ1e*jBVBnC;JH)}Z|M<(
z))Gx_nC0_7&v=v*k7G)1v>*oS<N?smLf5Ct#u`Z4O8LJD)PS-VFrEJ1;ib<j=bK*|
zBUbOPeo(Rc1C%fwth~vW|NHO%xE20zh>xKJ=AYi7c8p3SLQ<v(G2_()`bT*C4)^sd
lzwA%%$1l>4pOQ{U_oOAhz9U^rKmL-w|IAx>_dniXhP<QmXRiPN

delta 2254
zcmV;<2r>7)60{PKet$L+$M1d$rLtG6lB;i<*t?Z-O~n;gZH_32Y*Mg5fCfN~<kP;!
zzTQ4b8Xu&j@kpY8W-cR%5`Xw=bpO!+XUFSK+f{#j*XeqYu=;8B@t^OXe*e7Qx=#KW
zFTVZ9>g}6d_~p9lYW+OD{QC6%_dh@T+bhYfUHyD<_nq6;ynn74ubeiad~jP`XAml_
z98!uHbyavfYe9kGk_px5QkGEt;4A|P9jMZVF+Dg+To0zvrsJvtlExb7v;!Q)uGb3d
zM*`i05sj$06IvCqQl~Mer?<LcgQ$zBTi`X6S-pa1)^o!V0LHS$=&pQ(tp(#wZRTw@
zs@g)eE4v#lqkjPdXlJ$%Wbvirg%BL`{Ca@0g8{}jmK}QTw%MQ-9IL^KR)raZgYWyN
zta6@7WZVIDfNF4jBY|zCu66{qOAfJ^(_z=6B{=j9k~M>>yni6zjxM$sbT*@lS%Zc8
z1T5zT!!0!s@9p>K?YBbKIJXzTmCdgaSg0uyrsj^b)_?GRTkM+?ah#_c?nhTEir)K<
zNz#QvF|O)yYLwF`C`6T+CKVZou1c25(t4vYvRGR49aQj2X?hj6`dOP@BlR;u^{ke@
zekD%Q@;&6=T&7X1=z1xdV=;ii*CEK}{C+_3ZD;E4U|jKUaF*-$_~+mL<BT=s^_xSy
zs`P*@QhzP0MTqm<9LuV7Nkti9#DRd=0Mr|f3Ultl=MHZx+AUZwnymAyGy-I=trcF-
zjhcyRGjjoRgWPemW88XgV4dM&-u!(CXo-kPa__kjUf3=}rK+snd;uJ#JykWoYEfJ@
zp+qOX!DQ@(yvuO%Kv=)Qv>MmGO5>ogMw>DI6@Nkp6?(DAaQ-!@n)~p^<tL+&(q((d
zE2xlBnC5mLzhOq_+T^WbM!HWT4RUsdW_B5IweF?o<gTGUTkN$4FWCi)B$?IoibB79
z7LlelE?J_1#S1jR9k8x$7s2+l*xHM3bZ@|HrF%GwJqvZu%K{fQH$UWI!c2os&!-;f
zz<+FCNENI(c_CAr4N-#}k4riyLJP8m;Vrx!HcY}E<U)2D$~f9fAGJsk4x`DEEy0zM
zw%#Fe&A6$y!r`zFhIYhHquq|dos4a9d0b&&66l%4W^fn}7i&i<OAXxyjL*kS4a*yp
zKL9&lIBkx<YNf(_6YiKTfNtQX2yvbyPJe2Jy6SP^*SDvf+vKi-0$sj5iN;VkUmhyY
z3bk9XnB(8lfs;Z;6S2O~vZdC&@<PJB(%nWVzRWPC**Z1stgx`9_-KLY(#P<UGfBS(
zJi5m}pO&}4xx&mi0x*x7v)?|CoW1it2M-M&WLOMUM)WzWygOut(T4~LbxVcHO@F#w
z!Q}|cE2xuNon|{auq<c!N(t4Ls}|B`L7eXtP<T93bdAGek{U<IL2J+hl7W4;XcV{<
zP~9IHw^Sq|;|?ruE$mrfRI)?UJf8i2l{=g*mFes;YPs4HgfLukL+{&9h@u%_RP<Gh
z>7!8fvh|b;Ad2DZMkrh|NJ%z4UVq*2`U|f>RmaS&lxx_tl}$9*nR|L!Y{@qusqht=
zY^#m<1~q9<d%a^&@E|s8ad`z>3*#+sN(WL_xe>;?G<<X+^+Lo`cEtom7Wb-~noHTY
z@k?|VC@q~J!-m1)E~OYqsdm_;xp5@K+OyTEGdbC*n{f1*C^P^_p?Yu&P=6Qb-zoo-
zo%*{%wy67wb!Nco!Bk{ciya!jFHTHcD<Gyl=O2rj!F1f<3kfZJvE`O2up!+@=@tT)
zs4p?N^gxnWNF=Hy+c}P+p;GfYErAGV9p6C^geR%F=W^ar#CvE!D?AIRMD2fpec}I?
zDTR*ckM~Jgvcqu|ZQ<(x%6|z?3y;#xPE11NR!bnneV-VigomRkguvXBB(ETQsTWy=
z1um7k?v39{r=l4M3pV<goDL+BbLXBZy@!c;{>jwS14C5ZYEj|2{38hIsMY$Z=K527
zpR;#x4Kp4)$~n$8hgq=2c@;mVb&`G(4h(nN&=ueXpVZI(plELuDStM&DhCHgN)5+2
z{MqqiMQCDipDm5!R$woiYI|IS?sr_tz@t2T*sMEo5NbN)z5bBiJo(GB=i4nv+)+ta
zXzF!=j48Lpz?P8w>f>gQ^8K-sF#b71ba}J48c2s+z3Qz6Z?)pGtV(0-3)B!+a=Ck)
zA-c2c|HRjv2ET?_r+<s6b!v(#O}x0tFbBC)`dRv&7{B6p@#*9E=@<Moqq(zLml?zw
zdQdegy_p%m%wlFsipTi7O(ZW+byKyp&?s3eVX8rLzcm<7UHHStXi-wnDsFHBH5HE4
zIvp!`;D0oHcklRQw|^3b?cf-CadJrW>wvOEYBNQ$Jc8Q$s();bDH)Ul3GHy&Yl6_G
zTn-$1f9RiE_QgieoI`1Z#AUSj2E_pO^h*K5Kjj+_>!K3R?%QzK#HEaQ*xQ!q<PLPW
z<UMnN=TEDbjD7H0MxalWM;0?zxtQ`!4{F?>$ir3{0Y#i}PSt`N`Vz`e)+K`yUk9M*
z;4K{dR5$G=mwynFl@;%B-Cv~;n~mw^kbH4A!s0~mfgu;7F^)6uGI9aqBh?Lq1KM1+
zu{pnZ^qGAh;<Crr8Lq7N67gwy44wLXJFX0w+)jW-PgKN|;Y>+s5Ivzv0;zwptjMl|
zOc{?XJt{25o0Hf<UE{{AWKJC>ObrKI<LC6t`4;Y@t$#UmGWWjqhlBIFy8du_1pSVH
zzj^<9<|5@TBrmIR8(T@>svP5w6LIV2rikvtMjh}N=|V|><3c_>rAG`#OANWbmrwsZ
z<55o7j>);vKs6XE_JDB~x;~z4EP=$Sl>VDQ2`H(6Y4`UIFMeKGSHG)uwR(H;i`AbX
zE8W4$=|^<=|Ns4;UEvRh@ED3`{_qC9V{jq?5;H}J8LvjrZ~pBYoY$}XvOm5ZzlcA6
ciasIU6NmWnj(9Ep_;dXJ6K~<oUuSYw)Fpv=>Hq)$

diff --git a/doc/searchindex.js b/doc/searchindex.js
index b4fdfc03f..4dc6909bd 100644
--- a/doc/searchindex.js
+++ b/doc/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["KADMOS"],envversion:52,filenames:["KADMOS.rst"],objects:{"":{kadmos:[0,0,0,"-"]},"kadmos.cmdows.cmdows":{CMDOWS:[0,1,1,""]},"kadmos.cmdows.cmdows.CMDOWS":{add_actor:[0,2,1,""],add_contact:[0,2,1,""],add_dc:[0,2,1,""],add_dc_general_info:[0,2,1,""],add_dc_inputs_element:[0,2,1,""],add_dc_outputs_element:[0,2,1,""],add_dc_performance_info:[0,2,1,""],add_dc_remote_component_info:[0,2,1,""],add_dc_verification:[0,2,1,""],add_element_to_element_of_uid:[0,2,1,""],add_header:[0,2,1,""],add_new_parameters_from_element:[0,2,1,""],assert_element_tag:[0,2,1,""],check:[0,2,1,""],check_references:[0,2,1,""],check_schema:[0,2,1,""],check_uids:[0,2,1,""],ensure_abs_xpath:[0,2,1,""],get_design_competences_uids:[0,2,1,""],get_element_of_uid:[0,2,1,""],get_executable_blocks_uids:[0,2,1,""],get_inputs_uids:[0,2,1,""],get_mathematical_functions_uids:[0,2,1,""],get_outputs_uids:[0,2,1,""],get_parameters_uids:[0,2,1,""],get_used_parameter_uids:[0,2,1,""],get_xpath_of_uid:[0,2,1,""],remove_children_of_uid:[0,2,1,""],remove_children_of_xpath:[0,2,1,""],remove_contact:[0,2,1,""],remove_data_graph_element:[0,2,1,""],remove_element_based_on_uid:[0,2,1,""],remove_element_based_on_xpath:[0,2,1,""],remove_in_and_outputs:[0,2,1,""],remove_inputs:[0,2,1,""],remove_outputs:[0,2,1,""],remove_parameter:[0,2,1,""],remove_parameters:[0,2,1,""],remove_parameters_element:[0,2,1,""],remove_process_graph_element:[0,2,1,""],remove_unused_contacts:[0,2,1,""],remove_workflow_element:[0,2,1,""],resolve_uids:[0,2,1,""],save:[0,2,1,""],schema:[0,2,1,""],simplify:[0,2,1,""],simplify_equations:[0,2,1,""],version:[0,2,1,""]},"kadmos.graph.graph_data":{DataGraph:[0,1,1,""],FundamentalProblemGraph:[0,1,1,""],RepositoryConnectivityGraph:[0,1,1,""]},"kadmos.graph.graph_data.DataGraph":{get_coupling_dictionary:[0,2,1,""],get_coupling_matrix:[0,2,1,""],get_feedback_info:[0,2,1,""],get_highest_instance:[0,2,1,""],get_possible_function_order:[0,2,1,""],mark_as_constraint:[0,2,1,""],mark_as_constraints:[0,2,1,""],mark_as_design_variable:[0,2,1,""],mark_as_design_variables:[0,2,1,""],mark_as_objective:[0,2,1,""],mark_as_qois:[0,2,1,""],minimize_feedback:[0,2,1,""],remove_unused_outputs:[0,2,1,""],sort_nodes_for_process:[0,2,1,""],unmark_variable:[0,2,1,""]},"kadmos.graph.graph_data.FundamentalProblemGraph":{add_function_problem_roles:[0,2,1,""],add_problem_formulation:[0,2,1,""],check_and_get_coupled_functions_groups:[0,2,1,""],check_and_get_design_variables:[0,2,1,""],check_and_get_post_coupling_functions:[0,2,1,""],check_and_get_pre_coupling_functions:[0,2,1,""],create_mdg:[0,2,1,""],create_mpg:[0,2,1,""],determine_scope_constraint_functions:[0,2,1,""],determine_scope_design_variables:[0,2,1,""],get_group_couplings:[0,2,1,""],get_mdg:[0,2,1,""],get_mg_function_ordering:[0,2,1,""],get_objective_node:[0,2,1,""],get_partition_info:[0,2,1,""],get_sub_level_functions:[0,2,1,""],get_sys_post_couplings:[0,2,1,""],get_system_level_functions:[0,2,1,""],impose_mdao_architecture:[0,2,1,""],partition_graph:[0,2,1,""],select_distributed_architecture:[0,2,1,""],select_number_of_partitions:[0,2,1,""]},"kadmos.graph.graph_data.RepositoryConnectivityGraph":{create_mathematical_problem:[0,2,1,""],get_fpg_based_on_function_nodes:[0,2,1,""],get_fpg_based_on_list_functions:[0,2,1,""],get_fpg_based_on_sinks:[0,2,1,""],get_fpg_by_function_nodes:[0,2,1,""],get_function_paths_by_objective:[0,2,1,""],get_path_combinations:[0,2,1,""],select_function_combination_from:[0,2,1,""]},"kadmos.graph.graph_kadmos":{KadmosGraph:[0,1,1,""]},"kadmos.graph.graph_kadmos.KadmosGraph":{add_contact:[0,2,1,""],add_contact_roles:[0,2,1,""],add_dc_general_info:[0,2,1,""],add_dc_performance_info:[0,2,1,""],add_dc_remote_component_info:[0,2,1,""],add_default_description:[0,2,1,""],add_default_name:[0,2,1,""],add_edge:[0,2,1,""],add_instance:[0,2,1,""],add_node:[0,2,1,""],add_objective_function_by_nodes:[0,2,1,""],change_graph_class:[0,2,1,""],check:[0,2,1,""],check_cmdows_integrity:[0,2,1,""],check_for_coupling:[0,2,1,""],copy_as:[0,2,1,""],copy_edge:[0,2,1,""],copy_node_with_suffix:[0,2,1,""],count_function_nodes:[0,2,1,""],create_dsm:[0,2,1,""],deepcopy:[0,2,1,""],deepcopy_as:[0,2,1,""],disconnect_problematic_variables_from:[0,2,1,""],find_all_nodes:[0,2,1,""],get_adjacency_matrix:[0,2,1,""],get_architecture_node_ids:[0,2,1,""],get_architecture_node_labels:[0,2,1,""],get_categorized_nodes:[0,2,1,""],get_contracted_graph:[0,2,1,""],get_direct_coupling_nodes:[0,2,1,""],get_first_node_instance:[0,2,1,""],get_function_graph:[0,2,1,""],get_function_metadata:[0,2,1,""],get_function_nodes:[0,2,1,""],get_graph_properties:[0,2,1,""],get_node_attributes:[0,2,1,""],get_node_subcategory:[0,2,1,""],get_nodes_based_on_strings:[0,2,1,""],get_nodes_indegree:[0,2,1,""],get_nodes_outdegree:[0,2,1,""],get_nodes_subcategory:[0,2,1,""],get_number_of_couplings:[0,2,1,""],get_same_graph_class:[0,2,1,""],get_sources:[0,2,1,""],get_subgraph_by_function_nodes:[0,2,1,""],get_system_inputs:[0,2,1,""],get_targets:[0,2,1,""],graph_has_nested_attributes:[0,2,1,""],has_nodes:[0,2,1,""],inspect:[0,2,1,""],inspect_node:[0,2,1,""],inspect_nodes:[0,2,1,""],load_cmdows:[0,2,1,""],make_all_variables_valid:[0,2,1,""],merge_function_modes:[0,2,1,""],merge_function_nodes_based_on_modes:[0,2,1,""],merge_functions:[0,2,1,""],merge_parallel_functions:[0,2,1,""],merge_sequential_functions:[0,2,1,""],node_is_function:[0,2,1,""],node_is_hole:[0,2,1,""],node_is_objective_function:[0,2,1,""],node_is_output:[0,2,1,""],node_is_variable:[0,2,1,""],plot_adjacency_matrix:[0,2,1,""],plot_graph:[0,2,1,""],print_graph:[0,2,1,""],relabel_function_nodes:[0,2,1,""],remove_function_nodes:[0,2,1,""],save:[0,2,1,""],select_objectives_from_graph:[0,2,1,""],split_variables:[0,2,1,""]},"kadmos.graph.graph_process":{MdaoProcessGraph:[0,1,1,""]},"kadmos.graph.graph_process.MdaoProcessGraph":{add_process:[0,2,1,""],add_process_partitions:[0,2,1,""],connect_nested_iterators:[0,2,1,""],get_lowest_psn:[0,2,1,""],get_node_text:[0,2,1,""],get_ordered_cycles:[0,2,1,""],get_process_hierarchy:[0,2,1,""],get_process_list:[0,2,1,""],inspect_process:[0,2,1,""]},"kadmos.graph.mixin_equation":{EquationMixin:[0,1,1,""]},"kadmos.graph.mixin_equation.EquationMixin":{add_equation:[0,2,1,""],add_equation_label:[0,2,1,""],add_equation_labels:[0,2,1,""],add_mathematical_function:[0,2,1,""]},"kadmos.graph.mixin_mdao":{MdaoMixin:[0,1,1,""]},"kadmos.graph.mixin_mdao.MdaoMixin":{insert_node_on_diagonal:[0,2,1,""],remove_node_from_diagonal:[0,2,1,""]},"kadmos.graph.mixin_vistoms":{VistomsMixin:[0,1,1,""]},"kadmos.graph.mixin_vistoms.VistomsMixin":{vistoms_add:[0,2,1,""],vistoms_create:[0,2,1,""]},"kadmos.knowledgebase.knowledgebase":{KnowledgeBase:[0,1,1,""]},"kadmos.knowledgebase.knowledgebase.KnowledgeBase":{get_function_dependencies:[0,2,1,""],get_function_graph:[0,2,1,""],get_kb_graphs:[0,2,1,""],get_rcg:[0,2,1,""],print_circular_connections_in_log:[0,2,1,""]},"kadmos.utilities":{general:[0,0,0,"-"],printing:[0,0,0,"-"],strings:[0,0,0,"-"],xml:[0,0,0,"-"]},"kadmos.utilities.general":{assert_dict_keys:[0,3,1,""],color_list:[0,3,1,""],convert_bytes:[0,3,1,""],dict_to_ord_dict:[0,3,1,""],export_as_json:[0,3,1,""],file_size:[0,3,1,""],file_size_MB:[0,3,1,""],filter_group_vars:[0,3,1,""],format_string_for_latex:[0,3,1,""],format_string_for_vistoms:[0,3,1,""],get_element_dict:[0,3,1,""],get_friendly_id:[0,3,1,""],get_group_vars:[0,3,1,""],get_list_entries:[0,3,1,""],get_mdao_setup:[0,3,1,""],get_uid:[0,3,1,""],get_unique_friendly_id:[0,3,1,""],hex_to_rgb:[0,3,1,""],make_camel_case:[0,3,1,""],make_plural:[0,3,1,""],make_singular:[0,3,1,""],open_file:[0,3,1,""],remove_if_exists:[0,3,1,""],test_attr_cond:[0,3,1,""],transform_data_into_strings:[0,3,1,""],transform_string_into_format:[0,3,1,""],translate_dict_keys:[0,3,1,""],translate_list:[0,3,1,""],unmake_camel_case:[0,3,1,""]},"kadmos.utilities.printing":{print_in_table:[0,3,1,""],print_indexed_list:[0,3,1,""]},"kadmos.utilities.xml":{ExtendedElement:[0,1,1,""],get_element_details:[0,3,1,""],get_uid_search_xpath:[0,3,1,""],merge:[0,3,1,""],recursively_empty:[0,3,1,""],recursively_stringify:[0,3,1,""],recursively_unique_attribute:[0,3,1,""]},"kadmos.utilities.xml.ExtendedElement":{add:[0,2,1,""],add_process_hierarchy:[0,2,1,""],clean:[0,2,1,""],findasttext:[0,2,1,""],finddict:[0,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"13S":0,"1e4":0,"boolean":0,"byte":0,"case":0,"class":0,"default":0,"export":0,"final":0,"float":0,"function":0,"import":0,"int":0,"long":0,"new":0,"return":0,"super":0,"true":0,"try":0,"while":0,Adding:0,For:0,IDs:0,The:0,These:0,Use:0,Will:0,__all__:0,__none__:0,_check_category_a:0,_check_category_b:0,_check_category_c:0,abbreviate_keyword:0,abl:0,abov:0,absolut:0,access:0,accord:0,account:0,action:0,actual:0,add:0,add_actor:0,add_contact:0,add_contact_rol:0,add_dc:0,add_dc_general_info:0,add_dc_inputs_el:0,add_dc_outputs_el:0,add_dc_performance_info:0,add_dc_remote_component_info:0,add_dc_verif:0,add_default_descript:0,add_default_nam:0,add_edg:0,add_element_to_element_of_uid:0,add_equ:0,add_equation_label:0,add_function_problem_rol:0,add_head:0,add_inst:0,add_mathematical_funct:0,add_new_parameters_from_el:0,add_nod:0,add_objective_function_by_nod:0,add_problem_formul:0,add_process:0,add_process_hierarchi:0,add_process_partit:0,added:0,addit:0,address:0,adher:0,adjac:0,adjust:0,adress:0,advanc:0,aerodynam:0,aerospac:0,after:0,agil:0,aircraft:0,algorithm:0,all:0,all_keys_requir:0,all_nod:0,allow:0,allow_unconverged_coupl:0,alreadi:0,als:0,also:0,american:0,amount:0,analys:0,analysi:0,analyt:0,analyz:0,ani:0,anoth:0,append:0,appli:0,applic:0,appyl:0,arbitrari:0,architect:0,architectur:0,archiv:0,arg:0,argument:0,around:0,as_view:0,ascend:0,ascens:0,ask:0,assert:0,assert_dict_kei:0,assert_element_tag:0,assess:0,assign:0,associ:0,assum:0,ast:0,attr:0,attr_cond:0,attr_dict:0,attr_exclud:0,attr_includ:0,attr_list:0,attr_valu:0,attrb:0,attrib:0,attribut:0,automat:0,avail:0,back:0,base:0,baselin:0,basestr:0,becaus:0,becom:0,been:0,befor:0,being:0,belong:0,below:0,best:0,between:0,bisect:0,bli:0,bliss:0,block:0,bool:0,both:0,bound:0,box:0,bracket:0,branch:0,build:0,busi:0,calcul:0,camel:0,camel_case_convers:0,camelcas:0,can:0,capac:0,care:0,casi:0,categori:0,certain:0,chang:0,change_graph_class:0,charact:0,characterist:0,check:0,check_and_get_coupled_functions_group:0,check_and_get_design_vari:0,check_and_get_post_coupling_funct:0,check_and_get_pre_coupling_funct:0,check_cmdows_integr:0,check_for_coupl:0,check_graph:0,check_list:0,check_refer:0,check_schema:0,check_uid:0,child:0,children:0,children_to_keep:0,children_to_remov:0,choos:0,circular:0,circularconnect:0,clariti:0,clean:0,close:0,clutter:0,cmdowsvers:0,cnstrnt_var:0,collaborative_engin:0,collaborativeengin:0,collect:0,collid:0,collis:0,color:0,color_list:0,color_set:0,colors_based_on:0,column:0,combin:0,common:0,compani:0,compar:0,comparison:0,compet:0,compil:0,compile_pdf:0,complet:0,complex:0,compon:0,compos:0,compress:0,comput:0,condit:0,config:0,configur:0,connect:0,connect_nested_iter:0,conserv:0,consid:0,consider:0,consist:0,consistent_root:0,consol:0,constraint:0,contact:0,contact_uid:0,contain:0,content:0,contig:0,continu:0,contract:0,contracted_graph:0,contraction_level:0,conv:0,convent:0,converg:0,convers:0,convert:0,convert_byt:0,coor:0,copi:0,copy_a:0,copy_edg:0,copy_node_with_suffix:0,copy_typ:0,correspond:0,could:0,count:0,count_function_nod:0,countri:0,coupl:0,coupled_functions_group:0,coupling_dict:0,coupling_functions_group:0,coupling_strength:0,cpac:0,creat:0,create_dsm:0,create_mathematical_problem:0,create_mdg:0,create_mpg:0,creation:0,creation_d:0,creator:0,creator_uid:0,criteria:0,cross:0,current:0,current_group_idx:0,custom:0,cwd:0,cycl:0,d3j:0,data:0,data_exchange_dict:0,date:0,datetim:0,dc_uid:0,decrib:0,deep:0,deepcopi:0,deepcopy_a:0,defin:0,definit:0,degre:0,delet:0,delft:0,depart:0,depend:0,deprec:0,des_var:0,descend:0,describ:0,descript:0,design:0,designcompet:0,desir:0,destin:0,destination_fold:0,detail:0,determin:0,determine_scope_constraint_funct:0,determine_scope_design_vari:0,develop:0,dewit:0,diagon:0,diagonal_po:0,diagram:0,dic:0,dict:0,dict_to_ord_dict:0,dictionari:0,differ:0,differenti:0,digraph:0,dimens:0,direct:0,directli:0,directori:0,disciplin:0,disciplinari:0,disconnect:0,disconnect_collided_target:0,disconnect_problematic_variables_from:0,disconnect_shared_sourc:0,disregard:0,distinguis:0,distribut:0,divid:0,doe:0,doe_set:0,doesn:0,doing:0,done:0,download:0,draw:0,dsm:0,dtc:0,dubreuil:0,due:0,dummy_method:0,dummy_result:0,dummy_vers:0,duplic:0,dynam:0,each:0,easi:0,edg:0,edge_label:0,edge_or_nod:0,edu:0,either:0,element:0,element_to_add:0,elementtre:0,email:0,employe:0,empti:0,enabl:0,encod:0,end:0,end_in_iterative_nod:0,engin:0,enrich:0,ensur:0,ensure_abs_xpath:0,entri:0,entries_to_remov:0,equat:0,error:0,especi:0,etc:0,evalu:0,everi:0,everyth:0,exampl:0,exblock_uid:0,exce:0,except:0,exchang:0,exclud:0,exclus:0,execut:0,executableblock:0,exist:0,expect:0,expected_amount:0,expected_kei:0,expected_tag:0,expected_tag_new_el:0,expected_tag_uid_el:0,expected_text:0,explicit:0,export_as_json:0,express:0,extend:0,extendedel:0,extens:0,extra:0,extract:0,fals:0,feedback:0,feedforward:0,fidel:0,fidelity_level:0,fig_num:0,fig_siz:0,figur:0,file:0,file_nam:0,file_path:0,file_ref:0,file_s:0,file_size_mb:0,file_typ:0,filenam:0,filevers:0,filter:0,filter_group_var:0,filter_set:0,find:0,find_all_nod:0,findasttext:0,finddict:0,findtext:0,first:0,folder:0,follow:0,form:0,format:0,format_string_for_latex:0,format_string_for_vistom:0,formul:0,found:0,fpg:0,french:0,from:0,front:0,full:0,funcnam:0,function_nod:0,function_ord:0,function_order_method:0,function_typ:0,functiongraph:0,fundament:0,further:0,futur:0,gauss:0,get:0,get_adjacency_matrix:0,get_architecture_node_id:0,get_architecture_node_label:0,get_categorized_nod:0,get_contracted_graph:0,get_coupling_dictionari:0,get_coupling_matrix:0,get_design_competences_uid:0,get_direct_coupling_nod:0,get_element_detail:0,get_element_dict:0,get_element_of_uid:0,get_evalu:0,get_executable_blocks_uid:0,get_feedback_info:0,get_first_node_inst:0,get_fpg_based_on_function_nod:0,get_fpg_based_on_list_funct:0,get_fpg_based_on_sink:0,get_fpg_by_function_nod:0,get_friendly_id:0,get_function_depend:0,get_function_graph:0,get_function_metadata:0,get_function_nod:0,get_function_paths_by_object:0,get_graph_properti:0,get_group_coupl:0,get_group_var:0,get_highest_inst:0,get_inputs_uid:0,get_kb_graph:0,get_list_entri:0,get_lowest_psn:0,get_mathematical_functions_uid:0,get_mdao_setup:0,get_mdg:0,get_mg_function_ord:0,get_node_attribut:0,get_node_subcategori:0,get_node_text:0,get_nodes_based_on_str:0,get_nodes_indegre:0,get_nodes_outdegre:0,get_nodes_subcategori:0,get_number_of_coupl:0,get_objective_nod:0,get_ordered_cycl:0,get_outputs_uid:0,get_parameters_uid:0,get_partition_info:0,get_path_combin:0,get_possible_function_ord:0,get_process_hierarchi:0,get_process_list:0,get_rcg:0,get_same_graph_class:0,get_sourc:0,get_sub_level_funct:0,get_subgraph_by_function_nod:0,get_sys_post_coupl:0,get_system_input:0,get_system_level_funct:0,get_target:0,get_uid:0,get_uid_search_xpath:0,get_unique_friendly_id:0,get_used_parameter_uid:0,get_xpath_of_uid:0,give:0,given:0,gkhome:0,glaro:0,global:0,global_cnstrnt_funct:0,global_objective_funct:0,gov:0,graph_check_crit:0,graph_class:0,graph_data:0,graph_has_nested_attribut:0,graph_id:0,graph_kadmo:0,graph_process:0,graph_properti:0,graphml:0,group:0,group_dict:0,group_idx:0,guarante:0,guess:0,handl:0,has:0,has_nod:0,hash:0,hashabl:0,have:0,header:0,hello:0,here:0,hex:0,hex_to_rgb:0,hierarchi:0,higher_level_remov:0,highest:0,hold:0,hole:0,how:0,howev:0,html:0,http:0,identifi:0,idf:0,ids:0,ignor:0,ignore_func:0,ignore_list:0,ignore_mod:0,ignore_outdegre:0,ignorefunct:0,illustr:0,implement:0,impose_mdao_architectur:0,includ:0,include_al:0,include_reference_data:0,include_run_tim:0,include_system_var:0,increas:0,indec:0,indegre:0,indent:0,indentifi:0,independ:0,index:0,index_bracket:0,indic:0,info:0,inform:0,initi:0,inout:0,inp:0,input:0,input_list:0,input_nod:0,inputless:0,inputs_el:0,insert:0,insert_node_on_diagon:0,insid:0,inspect:0,inspect_nod:0,inspect_process:0,instanc:0,instance_id:0,instanceid:0,instead:0,integ:0,integr:0,interest:0,invalid:0,invalid_leaf_el:0,italian:0,item:0,iter:0,itertool:0,its:0,itself:0,ivang:0,japanes:0,jet:0,job:0,job_:0,job_nam:0,json:0,just:0,kb_dir_path:0,kdm:0,keep:0,keep_empty_el:0,keep_objective_vari:0,keep_run:0,keep_tex_fil:0,kei:0,key_ord:0,keys_to_be_remov:0,keyword:0,knowledg:0,knowledge_bas:0,kwarg:0,lab:0,label:0,label_extens:0,labeling_method:0,lafag:0,languag:0,larg:0,last:0,latex:0,lead:0,leaf:0,least:0,left:0,length:0,less:0,let:0,level:0,librari:0,limit:0,line:0,link:0,list:0,list_of_funct:0,list_of_nod:0,list_of_sink:0,list_of_tool:0,literatur:0,load:0,load_cmdow:0,local:0,local_cnstrnt_func:0,local_objective_funct:0,log:0,loop:0,lost:0,lower:0,lower_bound:0,lower_cas:0,lowest:0,maaik:0,mainli:0,maintain:0,make:0,make_all_variables_valid:0,make_camel_cas:0,make_plur:0,make_plural_opt:0,make_singular:0,mani:0,manipul:0,manual:0,map:0,mark:0,mark_as_constraint:0,mark_as_design_vari:0,mark_as_object:0,mark_as_qoi:0,master:0,match:0,mathemat:0,matplotlib:0,matrix:0,max_func:0,maxim:0,maximum:0,mda:0,mda_typ:0,mdao:0,mdao_architectur:0,mdao_definit:0,mdao_setup:0,mdaodatagraph:0,mdaograph:0,mddewit:0,mdf:0,mdg:0,mdo:0,mdo_architectur:0,meet:0,merg:0,merge_func:0,merge_funct:0,merge_function_mod:0,merge_function_nodes_based_on_mod:0,merge_parallel_funct:0,merge_sequential_funct:0,merger:0,messag:0,metadata:0,method:0,meti:0,mg_function_ord:0,might:0,min_func:0,mind:0,minim:0,minimize_feedback:0,minimum:0,mixin_equ:0,mixin_mdao:0,mixin_vistom:0,mode:0,mode_id:0,modeid:0,model:0,model_definit:0,modul:0,more:0,most:0,mpg:0,multi_start:0,multidigraph:0,multigraph:0,multipl:0,must:0,mutabl:0,my_obj_fcn_nam:0,mygraph:0,n_coupling_var:0,n_disciplin:0,n_global_constraint:0,n_global_var:0,n_limit:0,n_local_constraint:0,n_local_var:0,n_part:0,name:0,named_obj_fcn:0,namespac:0,nasa:0,nativ:0,need:0,neighbor:0,nest:0,networkx:0,new_edg:0,new_label:0,newli:0,next:0,next_sequ:0,node:0,node_id:0,node_is_funct:0,node_is_hol:0,node_is_objective_funct:0,node_is_output:0,node_is_vari:0,node_label:0,node_select:0,nomin:0,nominal_valu:0,non:0,none:0,nonetyp:0,notat:0,note:0,notifi:0,notification_messag:0,ntr:0,num:0,number:0,number_of_group:0,number_of_nod:0,numer:0,obj_vars_cov:0,object:0,obtain:0,off:0,old:0,old_edg:0,one:0,onera:0,ones:0,onli:0,only_add_if_valu:0,only_feedback:0,open:0,open_fil:0,open_pdf:0,openmdao:0,oper:0,operator_uid:0,opt:0,optim:0,option:0,order:0,ordereddict:0,organ:0,organiz:0,origin:0,other:0,otherwis:0,our:0,out:0,outdegre:0,outgo:0,outp:0,output:0,output_nod:0,outputless:0,outputs_el:0,overal:0,overview:0,owner:0,owner_uid:0,packag:0,page:0,pair:0,parallel:0,param:0,param_uid:0,paramet:0,parameters_el:0,params_uid:0,part:0,partit:0,partition_graph:0,partition_rang:0,partition_vari:0,pass:0,pate:0,path:0,path_or_el:0,paus:0,pdf:0,per:0,percentag:0,perform:0,pickl:0,place:0,platform:0,pleas:0,plot:0,plot_adjacency_matrix:0,plot_combo:0,plot_graph:0,plot_pareto_front:0,plural:0,png:0,point:0,posit:0,possibl:0,post:0,post_coupling_funct:0,pre:0,pre_coupling_funct:0,precis:0,predecessor:0,prefer:0,prefix:0,presenc:0,present:0,pretti:0,pretty_print:0,previou:0,previous_sequ:0,print_attribut:0,print_circular_connections_in_log:0,print_combo:0,print_contain:0,print_coupl:0,print_graph:0,print_in_log:0,print_in_t:0,print_indec:0,print_indexed_list:0,problem:0,problem_rol:0,problemat:0,problemgraph:0,process:0,process_hierarchi:0,process_step:0,processgraph:0,produc:0,product:0,project:0,prompt:0,properti:0,propuls:0,provid:0,psg:0,psn:0,pull:0,pure:0,purpos:0,pymerg:0,pyplot:0,python:0,quantiti:0,queri:0,quickli:0,quot:0,rais:0,raise_error:0,raise_error_if_tru:0,rang:0,rce:0,rcg:0,recognis:0,recommend:0,recurs:0,recursively_empti:0,recursively_stringifi:0,recursively_unique_attribut:0,reduc:0,ref:0,refer:0,reference_fil:0,reference_valu:0,refin:0,regular:0,reinstanti:0,rel:0,relabel:0,relabel_function_nod:0,relat:0,remain:0,remi:0,remot:0,remote_engin:0,remov:0,remove_after_compress:0,remove_children_of_uid:0,remove_children_of_xpath:0,remove_contact:0,remove_data_graph_el:0,remove_element_based_on_uid:0,remove_element_based_on_xpath:0,remove_function_nod:0,remove_if_exist:0,remove_in_and_output:0,remove_input:0,remove_nod:0,remove_node_from_diagon:0,remove_output:0,remove_paramet:0,remove_parameters_el:0,remove_process_graph_el:0,remove_unused_contact:0,remove_unused_output:0,remove_workflow_el:0,renam:0,replac:0,replacement_id:0,repres:0,request:0,requir:0,resolv:0,resolve_uid:0,resourc:0,respect:0,result:0,retriev:0,revers:0,rgb:0,right:0,role:0,root:0,round:0,row1:0,row2:0,rtype:0,run:0,run_tim:0,runtim:0,safe:0,same:0,sampl:0,sampledir:0,samplefil:0,satisfi:0,save:0,save_a:0,scalar:0,schema:0,scope:0,script:0,search:0,second:0,see:0,seidel:0,select:0,select_distributed_architectur:0,select_function_combination_from:0,select_number_of_partit:0,select_objectives_from_graph:0,self:0,sellar:0,separ:0,sequenc:0,server:0,set:0,sever:0,shallow:0,share:0,shorter:0,should:0,show:0,show_now:0,shown:0,side:0,sidebar:0,signific:0,simpl:0,simpli:0,simplifi:0,simplify_equ:0,sinc:0,singl:0,single_or_multi:0,single_or_multi_execut:0,singular:0,sink:0,situat:0,size:0,slave:0,small:0,some:0,some_fold:0,some_url:0,song:0,sonic:0,sort:0,sort_bi:0,sort_kei:0,sort_nodes_for_process:0,sourc:0,space:0,specif:0,specifi:0,split:0,split_vari:0,splittabl:0,spring:0,squar:0,standard:0,start:0,start_step:0,statement:0,statu:0,step:0,still:0,stop:0,store:0,str:0,stringifi:0,structur:0,student:0,sub:0,subcategori:0,subclass:0,subel:0,subgraph:0,subgroup:0,subscript:0,subset:0,subsystem:0,suffix:0,suit:0,summar:0,summarize_var:0,suppli:0,sure:0,svg:0,sylvain:0,symbol:0,sys_level_post_coupl:0,system:0,system_input:0,system_vari:0,tabl:0,tabul:0,tag:0,take:0,taken:0,target:0,telephon:0,test:0,test_attr_cond:0,test_valu:0,tex:0,text:0,textfil:0,thank:0,thei:0,them:0,therefor:0,thi:0,think:0,third:0,though:0,through:0,thu:0,time:0,timestamp:0,titl:0,togeth:0,tool:0,tool_specialist:0,toolspecialist:0,total:0,tpwgt:0,transform:0,transform_data_into_str:0,transform_string_into_format:0,translat:0,translate_dict_kei:0,translate_list:0,tree:0,tudelft:0,tupl:0,two:0,type:0,uid:0,uid_length:0,uml:0,umn:0,unconnect:0,under:0,underscor:0,undirect:0,uniqu:0,unmake_camel_cas:0,unmark:0,unmark_vari:0,unnamed_funct:0,until:0,unus:0,updat:0,upper:0,upper_bound:0,urlsit:0,usag:0,use:0,use_d3js_node_id:0,use_png_fig:0,use_pretty_print:0,used:0,used_id:0,useful:0,user:0,user_prompt_select_opt:0,using:0,utf:0,utm:0,uxpath:0,valid:0,valu:0,var_dim:0,var_valu:0,variabl:0,variableinstance1:0,variableinstance2:0,variableinstance3:0,variableinstance4:0,varieti:0,variou:0,verif:0,verifi:0,versatil:0,version:0,vistom:0,vistoms_add:0,vistoms_cr:0,vistoms_dir:0,vistoms_vers:0,visual:0,wai:0,wang:0,want:0,warn:0,weight:0,well:0,were:0,when:0,whether:0,which:0,window:0,wing:0,wit:0,within:0,without:0,work:0,workflow:0,write:0,write_problem_to_textfil:0,written:0,xdsm:0,xml_declar:0,xml_file:0,xmlschema:0,xpath:0,xpath_exclud:0,xpath_includ:0,xsd:0,yet:0,you:0,your:0,zero:0,zhang:0,zip:0},titles:["Welcome to KADMOS\u2019s documentation!"],titleterms:{cmdow:0,code:0,datagraph:0,document:0,equationmixin:0,fundamentalproblemgraph:0,gener:0,graph:0,kadmo:0,kadmosgraph:0,knowledgebas:0,mdaomixin:0,mdaoprocessgraph:0,print:0,repositoryconnectivitygraph:0,string:0,util:0,vistomsmixin:0,welcom:0,xml:0}})
\ No newline at end of file
+Search.setIndex({docnames:["KADMOS"],envversion:52,filenames:["KADMOS.rst"],objects:{"":{kadmos:[0,0,0,"-"]},"kadmos.cmdows.cmdows":{CMDOWS:[0,1,1,""]},"kadmos.cmdows.cmdows.CMDOWS":{add_actor:[0,2,1,""],add_contact:[0,2,1,""],add_dc:[0,2,1,""],add_dc_general_info:[0,2,1,""],add_dc_inputs_element:[0,2,1,""],add_dc_outputs_element:[0,2,1,""],add_dc_performance_info:[0,2,1,""],add_dc_remote_component_info:[0,2,1,""],add_dc_verification:[0,2,1,""],add_element_to_element_of_uid:[0,2,1,""],add_header:[0,2,1,""],add_new_parameters_from_element:[0,2,1,""],add_subelement:[0,2,1,""],assert_element_tag:[0,2,1,""],check:[0,2,1,""],check_references:[0,2,1,""],check_schema:[0,2,1,""],check_uids:[0,2,1,""],ensure_abs_xpath:[0,2,1,""],get_design_competences_uids:[0,2,1,""],get_element_of_uid:[0,2,1,""],get_executable_blocks_uids:[0,2,1,""],get_inputs_uids:[0,2,1,""],get_mathematical_functions_uids:[0,2,1,""],get_outputs_uids:[0,2,1,""],get_parameters_uids:[0,2,1,""],get_used_parameter_uids:[0,2,1,""],get_xpath_of_uid:[0,2,1,""],remove_actor:[0,2,1,""],remove_children_of_uid:[0,2,1,""],remove_children_of_xpath:[0,2,1,""],remove_contact:[0,2,1,""],remove_data_graph_element:[0,2,1,""],remove_element_based_on_uid:[0,2,1,""],remove_element_based_on_xpath:[0,2,1,""],remove_in_and_outputs:[0,2,1,""],remove_inputs:[0,2,1,""],remove_outputs:[0,2,1,""],remove_parameter:[0,2,1,""],remove_parameters:[0,2,1,""],remove_parameters_element:[0,2,1,""],remove_process_graph_element:[0,2,1,""],remove_unused_contacts:[0,2,1,""],remove_workflow_element:[0,2,1,""],resolve_uids:[0,2,1,""],save:[0,2,1,""],schema:[0,2,1,""],simplify:[0,2,1,""],simplify_equations:[0,2,1,""],version:[0,2,1,""]},"kadmos.graph.graph_data":{DataGraph:[0,1,1,""],FundamentalProblemGraph:[0,1,1,""],RepositoryConnectivityGraph:[0,1,1,""]},"kadmos.graph.graph_data.DataGraph":{get_coupling_dictionary:[0,2,1,""],get_coupling_matrix:[0,2,1,""],get_feedback_info:[0,2,1,""],get_highest_instance:[0,2,1,""],get_possible_function_order:[0,2,1,""],mark_as_constraint:[0,2,1,""],mark_as_constraints:[0,2,1,""],mark_as_design_variable:[0,2,1,""],mark_as_design_variables:[0,2,1,""],mark_as_objective:[0,2,1,""],mark_as_qois:[0,2,1,""],minimize_feedback:[0,2,1,""],remove_unused_outputs:[0,2,1,""],sort_nodes_for_process:[0,2,1,""],unmark_variable:[0,2,1,""]},"kadmos.graph.graph_data.FundamentalProblemGraph":{add_function_problem_roles:[0,2,1,""],add_problem_formulation:[0,2,1,""],check_and_get_coupled_functions_groups:[0,2,1,""],check_and_get_design_variables:[0,2,1,""],check_and_get_post_coupling_functions:[0,2,1,""],check_and_get_pre_coupling_functions:[0,2,1,""],create_mdg:[0,2,1,""],create_mpg:[0,2,1,""],determine_scope_constraint_functions:[0,2,1,""],determine_scope_design_variables:[0,2,1,""],get_group_couplings:[0,2,1,""],get_mdg:[0,2,1,""],get_mg_function_ordering:[0,2,1,""],get_objective_node:[0,2,1,""],get_partition_info:[0,2,1,""],get_sub_level_functions:[0,2,1,""],get_sys_post_couplings:[0,2,1,""],get_system_level_functions:[0,2,1,""],impose_mdao_architecture:[0,2,1,""],partition_graph:[0,2,1,""],select_distributed_architecture:[0,2,1,""],select_number_of_partitions:[0,2,1,""]},"kadmos.graph.graph_data.RepositoryConnectivityGraph":{create_mathematical_problem:[0,2,1,""],get_fpg_based_on_function_nodes:[0,2,1,""],get_fpg_based_on_list_functions:[0,2,1,""],get_fpg_based_on_sinks:[0,2,1,""],get_fpg_by_function_nodes:[0,2,1,""],get_function_paths_by_objective:[0,2,1,""],get_path_combinations:[0,2,1,""],select_function_combination_from:[0,2,1,""]},"kadmos.graph.graph_kadmos":{KadmosGraph:[0,1,1,""]},"kadmos.graph.graph_kadmos.KadmosGraph":{add_contact:[0,2,1,""],add_contact_roles:[0,2,1,""],add_dc_general_info:[0,2,1,""],add_dc_performance_info:[0,2,1,""],add_dc_remote_component_info:[0,2,1,""],add_default_description:[0,2,1,""],add_default_name:[0,2,1,""],add_edge:[0,2,1,""],add_instance:[0,2,1,""],add_node:[0,2,1,""],add_objective_function_by_nodes:[0,2,1,""],change_graph_class:[0,2,1,""],check:[0,2,1,""],check_cmdows_integrity:[0,2,1,""],check_for_coupling:[0,2,1,""],copy_as:[0,2,1,""],copy_edge:[0,2,1,""],copy_node_with_suffix:[0,2,1,""],count_function_nodes:[0,2,1,""],create_dsm:[0,2,1,""],deepcopy:[0,2,1,""],deepcopy_as:[0,2,1,""],disconnect_problematic_variables_from:[0,2,1,""],find_all_nodes:[0,2,1,""],get_adjacency_matrix:[0,2,1,""],get_architecture_node_ids:[0,2,1,""],get_architecture_node_labels:[0,2,1,""],get_categorized_nodes:[0,2,1,""],get_contracted_graph:[0,2,1,""],get_direct_coupling_nodes:[0,2,1,""],get_first_node_instance:[0,2,1,""],get_function_graph:[0,2,1,""],get_function_metadata:[0,2,1,""],get_function_nodes:[0,2,1,""],get_graph_properties:[0,2,1,""],get_node_attributes:[0,2,1,""],get_node_subcategory:[0,2,1,""],get_nodes_based_on_strings:[0,2,1,""],get_nodes_indegree:[0,2,1,""],get_nodes_outdegree:[0,2,1,""],get_nodes_subcategory:[0,2,1,""],get_number_of_couplings:[0,2,1,""],get_same_graph_class:[0,2,1,""],get_sources:[0,2,1,""],get_subgraph_by_function_nodes:[0,2,1,""],get_system_inputs:[0,2,1,""],get_targets:[0,2,1,""],graph_has_nested_attributes:[0,2,1,""],has_nodes:[0,2,1,""],inspect:[0,2,1,""],inspect_node:[0,2,1,""],inspect_nodes:[0,2,1,""],load_cmdows:[0,2,1,""],make_all_variables_valid:[0,2,1,""],merge_function_modes:[0,2,1,""],merge_function_nodes_based_on_modes:[0,2,1,""],merge_functions:[0,2,1,""],merge_parallel_functions:[0,2,1,""],merge_sequential_functions:[0,2,1,""],node_is_function:[0,2,1,""],node_is_hole:[0,2,1,""],node_is_objective_function:[0,2,1,""],node_is_output:[0,2,1,""],node_is_variable:[0,2,1,""],plot_adjacency_matrix:[0,2,1,""],plot_graph:[0,2,1,""],print_graph:[0,2,1,""],relabel_function_nodes:[0,2,1,""],remove_function_nodes:[0,2,1,""],save:[0,2,1,""],select_objectives_from_graph:[0,2,1,""],split_variables:[0,2,1,""]},"kadmos.graph.graph_process":{MdaoProcessGraph:[0,1,1,""]},"kadmos.graph.graph_process.MdaoProcessGraph":{add_process:[0,2,1,""],add_process_partitions:[0,2,1,""],connect_nested_iterators:[0,2,1,""],get_lowest_psn:[0,2,1,""],get_node_text:[0,2,1,""],get_ordered_cycles:[0,2,1,""],get_process_hierarchy:[0,2,1,""],get_process_list:[0,2,1,""],inspect_process:[0,2,1,""]},"kadmos.graph.mixin_equation":{EquationMixin:[0,1,1,""]},"kadmos.graph.mixin_equation.EquationMixin":{add_equation:[0,2,1,""],add_equation_label:[0,2,1,""],add_equation_labels:[0,2,1,""],add_mathematical_function:[0,2,1,""]},"kadmos.graph.mixin_mdao":{MdaoMixin:[0,1,1,""]},"kadmos.graph.mixin_mdao.MdaoMixin":{insert_node_on_diagonal:[0,2,1,""],remove_node_from_diagonal:[0,2,1,""]},"kadmos.graph.mixin_vistoms":{VistomsMixin:[0,1,1,""]},"kadmos.graph.mixin_vistoms.VistomsMixin":{vistoms_add:[0,2,1,""],vistoms_create:[0,2,1,""]},"kadmos.knowledgebase.knowledgebase":{KnowledgeBase:[0,1,1,""]},"kadmos.knowledgebase.knowledgebase.KnowledgeBase":{get_function_dependencies:[0,2,1,""],get_function_graph:[0,2,1,""],get_kb_graphs:[0,2,1,""],get_rcg:[0,2,1,""],print_circular_connections_in_log:[0,2,1,""]},"kadmos.utilities":{general:[0,0,0,"-"],printing:[0,0,0,"-"],strings:[0,0,0,"-"],xml:[0,0,0,"-"]},"kadmos.utilities.general":{assert_dict_keys:[0,3,1,""],color_list:[0,3,1,""],convert_bytes:[0,3,1,""],dict_to_ord_dict:[0,3,1,""],export_as_json:[0,3,1,""],file_size:[0,3,1,""],file_size_MB:[0,3,1,""],filter_group_vars:[0,3,1,""],format_string_for_latex:[0,3,1,""],format_string_for_vistoms:[0,3,1,""],get_element_dict:[0,3,1,""],get_friendly_id:[0,3,1,""],get_group_vars:[0,3,1,""],get_list_entries:[0,3,1,""],get_mdao_setup:[0,3,1,""],get_uid:[0,3,1,""],get_unique_friendly_id:[0,3,1,""],hex_to_rgb:[0,3,1,""],make_camel_case:[0,3,1,""],make_plural:[0,3,1,""],make_singular:[0,3,1,""],open_file:[0,3,1,""],remove_if_exists:[0,3,1,""],test_attr_cond:[0,3,1,""],transform_data_into_strings:[0,3,1,""],transform_string_into_format:[0,3,1,""],translate_dict_keys:[0,3,1,""],translate_list:[0,3,1,""],unmake_camel_case:[0,3,1,""]},"kadmos.utilities.printing":{print_in_table:[0,3,1,""],print_indexed_list:[0,3,1,""]},"kadmos.utilities.xml":{ExtendedElement:[0,1,1,""],get_element_details:[0,3,1,""],get_uid_search_xpath:[0,3,1,""],merge:[0,3,1,""],recursively_empty:[0,3,1,""],recursively_stringify:[0,3,1,""],recursively_unique_attribute:[0,3,1,""]},"kadmos.utilities.xml.ExtendedElement":{add:[0,2,1,""],add_process_hierarchy:[0,2,1,""],clean:[0,2,1,""],findasttext:[0,2,1,""],finddict:[0,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"13S":0,"1e4":0,"boolean":0,"byte":0,"case":0,"class":0,"default":0,"export":0,"final":0,"float":0,"function":0,"import":0,"int":0,"long":0,"new":0,"return":0,"super":0,"true":0,"try":0,"while":0,Adding:0,For:0,IDs:0,The:0,These:0,Use:0,Will:0,__all__:0,__none__:0,_check_category_a:0,_check_category_b:0,_check_category_c:0,abbreviate_keyword:0,abl:0,abov:0,absolut:0,access:0,accord:0,account:0,action:0,actual:0,add:0,add_actor:0,add_contact:0,add_contact_rol:0,add_dc:0,add_dc_general_info:0,add_dc_inputs_el:0,add_dc_outputs_el:0,add_dc_performance_info:0,add_dc_remote_component_info:0,add_dc_verif:0,add_default_descript:0,add_default_nam:0,add_edg:0,add_element_to_element_of_uid:0,add_equ:0,add_equation_label:0,add_function_problem_rol:0,add_head:0,add_inst:0,add_mathematical_funct:0,add_new_parameters_from_el:0,add_nod:0,add_objective_function_by_nod:0,add_problem_formul:0,add_process:0,add_process_hierarchi:0,add_process_partit:0,add_subel:0,added:0,addit:0,address:0,adher:0,adjac:0,adjust:0,adress:0,advanc:0,aerodynam:0,aerospac:0,after:0,agil:0,aircraft:0,algorithm:0,all:0,all_keys_requir:0,all_nod:0,allow:0,allow_unconverged_coupl:0,alreadi:0,als:0,also:0,american:[],amount:0,analys:0,analysi:0,analyt:0,analyz:0,ani:0,anoth:0,append:0,appli:0,applic:0,appyl:0,arbitrari:0,architect:0,architectur:0,archiv:0,arg:0,argument:0,around:0,as_view:0,ascend:0,ascens:0,ascii:0,ask:0,assert:0,assert_dict_kei:0,assert_element_tag:0,assess:0,assign:0,associ:0,assum:0,ast:0,attr:0,attr_cond:0,attr_dict:0,attr_exclud:0,attr_includ:0,attr_list:0,attr_valu:0,attrb:0,attrib:0,attribut:0,automat:0,avail:0,back:0,base:0,baselin:0,basestr:0,becaus:0,becom:0,been:0,befor:0,being:0,belong:0,below:0,best:0,between:0,bisect:0,bli:0,bliss:0,block:0,bool:0,both:0,bound:0,box:0,bracket:0,branch:0,build:0,busi:0,c14n:0,calcul:0,camel:0,camel_case_convers:0,camelcas:0,can:0,capac:0,care:0,casi:0,categori:0,certain:0,chang:0,change_graph_class:0,charact:0,characterist:0,check:0,check_and_get_coupled_functions_group:0,check_and_get_design_vari:0,check_and_get_post_coupling_funct:0,check_and_get_pre_coupling_funct:0,check_cmdows_integr:0,check_for_coupl:0,check_graph:0,check_list:0,check_refer:0,check_schema:0,check_uid:0,child:0,children:0,children_to_keep:0,children_to_remov:0,choos:0,circular:0,circularconnect:0,clariti:0,clean:0,close:0,clutter:0,cmdowsvers:0,cnstrnt_var:0,collaborative_engin:0,collaborativeengin:0,collect:0,collid:0,collis:0,color:0,color_list:0,color_set:0,colors_based_on:0,column:0,combin:0,common:0,compani:0,compar:0,comparison:0,compet:0,compil:0,compile_pdf:0,complet:0,complex:0,compon:0,compos:0,compress:0,comput:0,condit:0,config:0,configur:0,connect:0,connect_nested_iter:0,conserv:0,consid:0,consider:0,consist:0,consistent_root:0,consol:0,constraint:0,contact:0,contact_uid:0,contain:0,content:0,contig:0,continu:0,contract:0,contracted_graph:0,contraction_level:0,conv:0,convent:0,converg:0,convers:0,convert:0,convert_byt:0,coor:0,copi:0,copy_a:0,copy_edg:0,copy_node_with_suffix:0,copy_typ:0,correspond:0,could:0,count:0,count_function_nod:0,countri:0,coupl:0,coupled_functions_group:0,coupling_dict:0,coupling_functions_group:0,coupling_strength:0,cpac:0,creat:0,create_dsm:0,create_mathematical_problem:0,create_mdg:0,create_mpg:0,creation:0,creation_d:0,creator:0,creator_uid:0,criteria:0,cross:0,current:0,current_group_idx:0,custom:0,cwd:0,cycl:0,d3j:0,data:0,data_exchange_dict:0,date:0,datetim:0,dc_uid:0,declar:0,decrib:0,deep:0,deepcopi:0,deepcopy_a:0,defin:0,definit:0,degre:0,delet:0,delft:0,depart:0,depend:0,deprec:0,des_var:0,descend:0,describ:0,descript:0,design:0,designcompet:0,desir:0,destin:0,destination_fold:0,detail:0,determin:0,determine_scope_constraint_funct:0,determine_scope_design_vari:0,develop:0,dewit:0,diagon:0,diagonal_po:0,diagram:0,dic:0,dict:0,dict_to_ord_dict:0,dictionari:0,differ:0,differenti:0,digraph:0,dimens:0,direct:0,directli:0,directori:0,disciplin:0,disciplinari:0,disconnect:0,disconnect_collided_target:0,disconnect_problematic_variables_from:0,disconnect_shared_sourc:0,disregard:0,distinguis:0,distribut:0,divid:0,doe:0,doe_set:0,doesn:0,doing:0,done:0,download:0,draw:0,dsm:0,dtc:0,dubreuil:0,due:0,dummy_method:0,dummy_result:0,dummy_vers:0,duplic:0,dynam:0,each:0,easi:0,edg:0,edge_label:0,edge_or_nod:0,edu:0,either:0,element:0,element_to_add:0,elementtre:0,email:0,employe:0,empti:0,enabl:0,encod:0,end:0,end_in_iterative_nod:0,engin:0,enrich:0,ensur:0,ensure_abs_xpath:0,entri:0,entries_to_remov:0,equat:0,error:0,especi:0,etc:0,evalu:0,everi:0,everyth:0,exampl:0,exblock_uid:0,exce:0,except:0,exchang:0,exclud:0,exclus:0,execut:0,executableblock:0,exist:0,expect:0,expected_amount:0,expected_kei:0,expected_tag:0,expected_tag_new_el:0,expected_tag_uid_el:0,expected_text:0,explicit:0,export_as_json:0,express:0,extend:0,extendedel:0,extens:0,extern:0,extra:0,extract:0,fals:0,feedback:0,feedforward:0,fidel:0,fidelity_level:0,fig_num:0,fig_siz:0,figur:0,file:0,file_nam:0,file_path:0,file_ref:0,file_s:0,file_size_mb:0,file_typ:0,filenam:0,filevers:0,filter:0,filter_group_var:0,filter_set:0,find:0,find_all_nod:0,findasttext:0,finddict:0,findtext:0,first:0,folder:0,follow:0,form:0,format:0,format_string_for_latex:0,format_string_for_vistom:0,formul:0,found:0,fpg:0,french:0,from:0,front:0,full:0,funcnam:0,function_nod:0,function_ord:0,function_order_method:0,function_typ:0,functiongraph:0,fundament:0,further:0,futur:0,gauss:0,get:0,get_adjacency_matrix:0,get_architecture_node_id:0,get_architecture_node_label:0,get_categorized_nod:0,get_contracted_graph:0,get_coupling_dictionari:0,get_coupling_matrix:0,get_design_competences_uid:0,get_direct_coupling_nod:0,get_element_detail:0,get_element_dict:0,get_element_of_uid:0,get_evalu:0,get_executable_blocks_uid:0,get_feedback_info:0,get_first_node_inst:0,get_fpg_based_on_function_nod:0,get_fpg_based_on_list_funct:0,get_fpg_based_on_sink:0,get_fpg_by_function_nod:0,get_friendly_id:0,get_function_depend:0,get_function_graph:0,get_function_metadata:0,get_function_nod:0,get_function_paths_by_object:0,get_graph_properti:0,get_group_coupl:0,get_group_var:0,get_highest_inst:0,get_inputs_uid:0,get_kb_graph:0,get_list_entri:0,get_lowest_psn:0,get_mathematical_functions_uid:0,get_mdao_setup:0,get_mdg:0,get_mg_function_ord:0,get_node_attribut:0,get_node_subcategori:0,get_node_text:0,get_nodes_based_on_str:0,get_nodes_indegre:0,get_nodes_outdegre:0,get_nodes_subcategori:0,get_number_of_coupl:0,get_objective_nod:0,get_ordered_cycl:0,get_outputs_uid:0,get_parameters_uid:0,get_partition_info:0,get_path_combin:0,get_possible_function_ord:0,get_process_hierarchi:0,get_process_list:0,get_rcg:0,get_same_graph_class:0,get_sourc:0,get_sub_level_funct:0,get_subgraph_by_function_nod:0,get_sys_post_coupl:0,get_system_input:0,get_system_level_funct:0,get_target:0,get_uid:0,get_uid_search_xpath:0,get_unique_friendly_id:0,get_used_parameter_uid:0,get_xpath_of_uid:0,give:0,given:0,gkhome:0,glaro:0,global:0,global_cnstrnt_funct:0,global_objective_funct:0,gov:0,graph_check_crit:0,graph_class:0,graph_data:0,graph_has_nested_attribut:0,graph_id:0,graph_kadmo:0,graph_process:0,graph_properti:0,graphml:0,group:0,group_dict:0,guarante:0,guess:0,handl:0,has:0,has_nod:0,hash:0,hashabl:0,have:0,header:0,hello:0,here:0,hex:0,hex_to_rgb:0,hierarchi:0,higher:0,higher_level_remov:0,highest:0,hold:0,hole:0,how:0,howev:0,html:0,http:0,identifi:0,idf:0,ids:0,ignor:0,ignore_func:0,ignore_list:0,ignore_mod:0,ignore_outdegre:0,ignorefunct:0,illustr:0,implement:0,impose_mdao_architectur:0,includ:0,include_al:0,include_reference_data:0,include_run_tim:0,include_system_var:0,increas:0,indec:0,indegre:0,indent:0,indentifi:0,independ:0,index:0,index_bracket:0,indic:0,info:0,inform:0,initi:0,inout:0,inp:0,input:0,input_list:0,input_nod:0,inputless:0,inputs_el:0,insert:0,insert_node_on_diagon:0,insid:0,inspect:0,inspect_nod:0,inspect_process:0,instanc:0,instance_id:0,instanceid:0,instead:0,integ:0,integr:0,interest:0,invalid:0,invalid_leaf_el:0,italian:[],item:0,iter:0,itertool:0,its:0,itself:0,ivang:0,japanes:[],jet:0,job:0,job_:0,job_nam:0,json:0,just:0,kb_dir_path:0,kdm:0,keep:0,keep_empty_el:0,keep_objective_vari:0,keep_run:0,keep_tex_fil:0,kei:0,kept:0,key_ord:0,keys_to_be_remov:0,keyword:0,knowledg:0,knowledge_bas:0,kwarg:0,lab:0,label:0,label_extens:0,labeling_method:0,lafag:0,languag:0,larg:0,last:0,latex:0,lead:0,leaf:0,least:0,left:0,length:0,less:0,let:0,level:0,librari:0,limit:0,line:0,link:0,list:0,list_of_funct:0,list_of_nod:0,list_of_sink:0,list_of_tool:0,literatur:0,load:0,load_cmdow:0,local:0,local_cnstrnt_func:0,local_objective_funct:0,log:0,loop:0,lost:0,lower:0,lower_bound:0,lower_cas:0,lowest:0,maaik:0,mainli:0,maintain:0,make:0,make_all_variables_valid:0,make_camel_cas:0,make_plur:0,make_plural_opt:0,make_singular:0,mani:0,manipul:0,manual:0,map:0,mark:0,mark_as_constraint:0,mark_as_design_vari:0,mark_as_object:0,mark_as_qoi:0,master:0,match:0,mathemat:0,matplotlib:0,matrix:0,max_func:0,maxim:0,maximum:0,mda:0,mda_typ:0,mdao:0,mdao_architectur:0,mdao_definit:0,mdao_setup:0,mdaodatagraph:0,mdaograph:0,mddewit:0,mdf:0,mdg:0,mdo:0,mdo_architectur:0,meet:0,merg:0,merge_func:0,merge_funct:0,merge_function_mod:0,merge_function_nodes_based_on_mod:0,merge_parallel_funct:0,merge_sequential_funct:0,merger:0,messag:0,metadata:0,method:0,meti:0,mg_function_ord:0,might:0,min_func:0,mind:0,minim:0,minimize_feedback:0,minimum:0,mixin_equ:0,mixin_mdao:0,mixin_vistom:0,mode:0,mode_id:0,modeid:0,model:0,model_definit:0,modul:0,more:0,most:0,mpg:0,multi_start:0,multidigraph:0,multigraph:0,multipl:0,must:0,mutabl:0,my_obj_fcn_nam:0,mygraph:0,n_coupling_var:0,n_disciplin:0,n_global_constraint:0,n_global_var:0,n_limit:0,n_local_constraint:0,n_local_var:0,n_part:0,name:0,named_obj_fcn:0,namespac:0,nasa:0,nativ:[],need:0,neighbor:0,nest:0,networkx:0,new_edg:0,new_label:0,newli:0,next:0,next_sequ:0,node:0,node_id:0,node_is_funct:0,node_is_hol:0,node_is_objective_funct:0,node_is_output:0,node_is_vari:0,node_label:0,node_select:0,nomin:0,nominal_valu:0,non:0,none:0,nonetyp:0,notat:0,note:0,notifi:0,notification_messag:0,ntr:0,num:0,number:0,number_of_group:0,number_of_nod:0,numer:0,obj_vars_cov:0,object:0,obtain:0,off:0,old:0,old_edg:0,one:0,onera:0,ones:0,onli:0,only_add_if_valu:0,only_feedback:0,open:0,open_fil:0,open_pdf:0,openmdao:0,oper:0,operator_uid:0,opt:0,optim:0,option:0,order:0,ordereddict:0,organ:0,organiz:0,origin:0,other:0,otherwis:0,our:0,out:0,outdegre:0,outgo:0,outp:0,output:0,output_nod:0,outputless:0,outputs_el:0,overal:0,overlap:0,overview:0,owner:0,owner_uid:0,packag:0,page:0,pair:0,parallel:0,param:0,param_uid:0,paramet:0,parameters_el:0,params_uid:0,part:0,partit:0,partition_graph:0,partition_rang:0,partition_vari:0,pass:0,pate:0,path:0,path_or_el:0,paus:0,pdf:0,per:0,percentag:0,perform:0,pickl:0,place:0,platform:0,pleas:0,plot:0,plot_adjacency_matrix:0,plot_combo:0,plot_graph:0,plot_pareto_front:0,plural:0,png:0,point:0,posit:0,possibl:0,post:0,post_coupling_funct:0,pre:0,pre_coupling_funct:0,precis:0,predecessor:0,prefer:0,prefix:0,presenc:0,present:0,pretti:0,pretty_print:0,previou:0,previous_sequ:0,print_attribut:0,print_circular_connections_in_log:0,print_combo:0,print_contain:0,print_coupl:0,print_graph:0,print_in_log:0,print_in_t:0,print_indec:0,print_indexed_list:0,problem:0,problem_rol:0,problemat:0,problemgraph:0,process:0,process_hierarchi:0,process_step:0,processgraph:0,produc:0,product:0,project:0,prompt:0,properti:0,propuls:0,provid:0,psg:0,psn:0,pull:0,pure:0,purpos:0,pymerg:0,pyplot:0,python:0,quantiti:0,queri:0,quickli:0,quot:0,rais:0,raise_error:0,raise_error_if_tru:0,rang:0,rce:0,rcg:0,recognis:0,recommend:0,recurs:0,recursively_empti:0,recursively_stringifi:0,recursively_unique_attribut:0,reduc:0,ref:0,refer:0,reference_fil:0,reference_valu:0,refin:0,regular:0,reinstanti:0,rel:0,relabel:0,relabel_function_nod:0,relat:0,remain:0,remi:0,remot:0,remote_engin:0,remov:0,remove_actor:0,remove_after_compress:0,remove_children_of_uid:0,remove_children_of_xpath:0,remove_contact:0,remove_data_graph_el:0,remove_element_based_on_uid:0,remove_element_based_on_xpath:0,remove_function_nod:0,remove_if_exist:0,remove_in_and_output:0,remove_input:0,remove_nod:0,remove_node_from_diagon:0,remove_output:0,remove_paramet:0,remove_parameters_el:0,remove_process_graph_el:0,remove_unused_contact:0,remove_unused_output:0,remove_workflow_el:0,renam:0,replac:0,replacement_id:0,repres:0,request:0,requir:0,resolv:0,resolve_uid:0,resourc:0,respect:0,result:0,retriev:0,revers:0,rgb:0,right:0,role:0,root:0,round:0,row1:0,row2:0,rtype:0,run:0,run_tim:0,runtim:0,safe:0,same:0,sampl:0,sampledir:0,samplefil:0,satisfi:0,save:0,save_a:0,scalar:0,schema:0,scope:0,script:0,search:0,second:0,see:0,seidel:0,select:0,select_distributed_architectur:0,select_function_combination_from:0,select_number_of_partit:0,select_objectives_from_graph:0,self:0,sellar:0,separ:0,sequenc:0,server:0,set:0,sever:0,shallow:0,share:0,shorter:0,should:0,show:0,show_now:0,shown:0,side:0,sidebar:0,signific:0,simpl:0,simpli:0,simplifi:0,simplify_equ:0,sinc:0,singl:0,single_or_multi:0,single_or_multi_execut:0,singular:0,sink:0,situat:0,size:0,slave:0,small:0,some:0,some_fold:0,some_url:0,song:0,sonic:0,sort:0,sort_bi:0,sort_kei:0,sort_nodes_for_process:0,sourc:0,space:0,specif:0,specifi:0,split:0,split_vari:0,splittabl:0,spring:0,squar:0,standard:0,start:0,start_step:0,statement:0,statu:0,step:0,still:0,stop:0,store:0,str:0,stringifi:0,structur:0,student:0,sub:0,subcategori:0,subclass:0,subel:0,subelement_xpath_tag:0,subgraph:0,subgroup:0,subscript:0,subset:0,subsystem:0,suffix:0,suit:0,summar:0,summarize_var:0,suppli:0,sure:0,svg:0,sylvain:0,symbol:0,sys_level_post_coupl:0,system:0,system_input:0,system_vari:0,tabl:0,tabul:0,tag:0,take:0,taken:0,target:0,telephon:0,test:0,test_attr_cond:0,test_valu:0,tex:0,text:0,textfil:0,thank:0,thei:0,them:0,therefor:0,thi:0,think:[],third:0,though:0,through:0,thu:0,time:0,timestamp:0,titl:0,togeth:0,tool:0,tool_specialist:0,toolspecialist:0,total:0,tpwgt:0,transform:0,transform_data_into_str:0,transform_string_into_format:0,translat:0,translate_dict_kei:0,translate_list:0,tree:0,tudelft:0,tupl:0,two:0,type:0,uid:0,uid_length:0,uml:0,umn:0,unconnect:0,under:0,underscor:0,undirect:0,uniqu:0,unmake_camel_cas:0,unmark:0,unmark_vari:0,unnamed_funct:0,until:0,unus:0,updat:0,upper:0,upper_bound:0,urlsit:0,usag:0,use:0,use_d3js_node_id:0,use_png_fig:0,use_pretty_print:0,used:0,used_id:0,useful:0,user:0,user_prompt_select_opt:0,using:0,utf:0,utm:0,uxpath:0,valid:0,valu:0,var_dim:0,var_valu:0,variabl:0,variableinstance1:0,variableinstance2:0,variableinstance3:0,variableinstance4:0,varieti:0,variou:0,verif:0,verifi:0,versatil:0,version:0,vistom:0,vistoms_add:0,vistoms_cr:0,vistoms_dir:0,vistoms_vers:0,visual:0,wai:0,wang:0,want:0,warn:0,weight:0,well:0,were:0,when:0,whether:0,which:0,window:0,wing:0,wit:0,within:0,without:0,work:0,workflow:0,write:0,write_problem_to_textfil:0,written:0,xdsm:0,xml_declar:0,xml_file:0,xmlschema:0,xpath:0,xpath_exclud:0,xpath_includ:0,xsd:0,yet:0,you:0,your:0,zero:0,zhang:0,zip:0},titles:["Welcome to KADMOS\u2019s documentation!"],titleterms:{cmdow:0,code:0,datagraph:0,document:0,equationmixin:0,fundamentalproblemgraph:0,gener:0,graph:0,kadmo:0,kadmosgraph:0,knowledgebas:0,mdaomixin:0,mdaoprocessgraph:0,print:0,repositoryconnectivitygraph:0,string:0,util:0,vistomsmixin:0,welcom:0,xml:0}})
\ No newline at end of file
diff --git a/kadmos/cmdows/cmdows.py b/kadmos/cmdows/cmdows.py
index 7253a8fd1..e52111f4e 100644
--- a/kadmos/cmdows/cmdows.py
+++ b/kadmos/cmdows/cmdows.py
@@ -798,7 +798,13 @@ class CMDOWS(object):
         return
 
     def add_new_parameters_from_element(self, parameters_element):
-        """Method to add the new parameters based on a parameters element."""
+        """Method to add the new parameters based on a parameters element.
+
+        :param parameters_element: new parameters
+        :type parameters_element: element
+        :return: enriched parameters branch
+        :rtype: XMLSchema
+        """
 
         # First ensure a parameters XPath
         el = self.ensure_abs_xpath('/cmdows/parameters')
@@ -818,7 +824,23 @@ class CMDOWS(object):
         return
 
     def add_actor(self, contact_uid, role):
-        """Method to add a role element to the organization branch."""
+        """Method to add a role element to the organization branch.
+
+        :param contact_uid: uID of the contact
+        :type contact_uid: basestring
+        :param role: contact role
+        :type role: str
+        :return: enriched organizational branch
+        :rtype: XMLSchema
+
+        .. note:: Role options are:
+
+            * 'architect'
+            * 'integrator'
+            * 'collaborative_engineer'
+            * 'tool_specialist'
+            * 'customer'
+        """
 
         # Input assertions
         self.get_element_of_uid(contact_uid)
@@ -835,6 +857,15 @@ class CMDOWS(object):
         return
 
     def add_subelement(self, element, subelement_xpath_tag):
+        """Method to add a subelement to an existing element.
+
+        :param element: element to be added to
+        :type element: element
+        :param subelement_xpath_tag: subelement to be added.
+        :type subelement_xpath_tag: xpath/tag
+        :return: enriched element branch
+        :rtype: XMLSchema
+        """
         if "@uID" in subelement_xpath_tag:
             el_tag = find_until(subelement_xpath_tag, '[')
             uid_attr = find_between(subelement_xpath_tag, '[@uID="', '"]')
@@ -847,7 +878,13 @@ class CMDOWS(object):
         return
 
     def ensure_abs_xpath(self, xpath):
-        """Method to ensure that the elements given by an absolute XPath exist."""
+        """Method to ensure that the elements given by an absolute XPath exist.
+
+        :param xpath: XPath to be checked
+        :type xpath: basestring
+        :return: checked XPath
+        :rtype: basestring
+        """
         split_path = xpath.split('/')
         assert not split_path[0] and split_path[-1] and len(split_path) > 1, \
             'Invalid XPath ({}) provided. XPath should start with / sign and have at least one entry.'.format(xpath)
@@ -862,7 +899,11 @@ class CMDOWS(object):
         return self.root.xpath(local_xpath)[0]
 
     def resolve_uids(self):
-        """Method to rename duplicate UIDs in a CMDOWS file"""
+        """Method to rename duplicate uIDs in a CMDOWS file.
+
+        :return: renamed duplicate uIDs
+        :rtype: XMLSchema
+        """
         logger.warning('The resolve_uids method is a hack and should not be used.')
         ids = [element.attrib['uID'] for element in self.root.xpath('.//*[@uID]')]
         result = (len(ids) == len(set(ids)))
@@ -877,25 +918,55 @@ class CMDOWS(object):
     #             Remove functions              #
     # ----------------------------------------- #
     def remove_inputs(self, exblock_uid):
-        """Method to remove the inputs of a CMDOWS file executableBlock entry"""
+        """Method to remove the inputs of a CMDOWS file executableBlock entry.
+
+        :param exblock_uid: executableBlock to remove the inputs from
+        :type exblock_uid: basestring
+        :return: executableBlock without inputs
+        :rtype: XMLSchema
+        """
         assert self.get_element_of_uid(exblock_uid).getparent().getparent().tag == 'executableBlocks', \
             'UID ' + exblock_uid + ' does not seem to refer to an executableBlock.'
         self.remove_children_of_xpath(exblock_uid, children_to_remove=['inputs'])
 
     def remove_outputs(self, exblock_uid):
-        """Method to remove the outputs of a CMDOWS file executableBlock entry"""
+        """Method to remove the outputs of a CMDOWS file executableBlock entry.
+
+        :param exblock_uid: executableBlock to remove the outputs from
+        :type exblock_uid: basestring
+        :return: executableBlock without outputs
+        :rtype: XMLSchema
+        """
         assert self.get_element_of_uid(exblock_uid).getparent().getparent().tag == 'executableBlocks', \
             'UID ' + exblock_uid + ' does not seem to refer to an executableBlock.'
         self.remove_children_of_xpath(exblock_uid, children_to_remove=['outputs'])
 
     def remove_in_and_outputs(self, exblock_uid):
-        """Method to remove the in- and outputs of a CMDOWS file executableBlock entry"""
+        """Method to remove the in- and outputs of a CMDOWS file executableBlock entry.
+
+        :param exblock_uid: executableBlock to remove the in- and outputs from
+        :type exblock_uid: basestring
+        :return: executableBlock without in- and outputs
+        :rtype: XMLSchema
+        """
         assert self.get_element_of_uid(exblock_uid).getparent().getparent().tag == 'executableBlocks', \
             'UID ' + exblock_uid + ' does not seem to refer to an executableBlock.'
         self.remove_children_of_xpath(exblock_uid, children_to_remove=['inputs', 'outputs'])
 
     def remove_children_of_uid(self, uid, children_to_remove='__all__', children_to_keep='__none__'):
-        """Method to remove the children of a CMDOWS file element based on a UID."""
+        """Method to remove the children of a CMDOWS file element based on a uID.
+
+        :param uid: uID of the element to remove the children of
+        :type uid: basestring
+        :param children_to_remove: (optional) list of children to be removed (default: remove all)
+        :type children_to_remove: element
+        :param children_to_keep: (optional) list of children to be kept (default: keep none)
+        :type children_to_keep: element
+        :return: element with (certain) children removed
+        :rtype: XMLSchema
+
+        .. attention:: make sure the child elements contained in the two lists do not overlap.
+        """
         el = self.get_element_of_uid(uid)
         for child in el.iterchildren():
             if children_to_remove == '__all__':
@@ -908,7 +979,19 @@ class CMDOWS(object):
                 el.remove(child)
 
     def remove_children_of_xpath(self, xpath, children_to_remove='__all__', children_to_keep='__none__'):
-        """Method to remove the children of a CMDOWS file element based on an XPath."""
+        """Method to remove the children of a CMDOWS file element based on an XPath.
+
+        :param xpath: XPath of the element to remove the children of
+        :type xpath: basestring
+        :param children_to_remove: (optional) list of children to be removed (default: remove all)
+        :type children_to_remove: element
+        :param children_to_keep: (optional) list of children to be kept (default: keep none)
+        :type children_to_keep: element
+        :return: element with (certain) children removed
+        :rtype: XMLSchema
+
+        .. attention:: make sure the child elements contained in the two lists do not overlap.
+        """
         el = self.root.xpath(xpath)
         for child in el.iterchildren():
             if children_to_remove == '__all__':
@@ -921,41 +1004,77 @@ class CMDOWS(object):
                 el.remove(child)
 
     def remove_parameters_element(self):
-        """Method to remove a parameters element from a CMDOWS file."""
+        """Method to remove a parameters element from a CMDOWS file.
+
+        :return: Schema without parameters
+        :rtype: XMLSchema
+        """
         el = self.root.xpath('/cmdows/parameters')
         assert len(el) <= 1, '"/cmdows/parameters" is not a unique XPath. Check given CMDOWS file structure.'
         if el:
             el[0].getparent().remove(el[0])
 
     def remove_workflow_element(self):
-        """Method to remove a workflow element from a CMDOWS file."""
+        """Method to remove a workflow element from a CMDOWS file.
+
+        :return: Schema without workflow
+        :rtype: XMLSchema
+        """
         el = self.root.xpath('/cmdows/workflow')
         assert len(el) <= 1, '"/cmdows/workflow" is not a unique XPath. Check given CMDOWS file structure.'
         if el:
             el[0].getparent().remove(el[0])
 
     def remove_data_graph_element(self):
-        """Method to remove a dataGraph element from a CMDOWS file."""
+        """Method to remove a dataGraph element from a CMDOWS file.
+
+        :return: Schema without dataGraph
+        :rtype: XMLSchema
+        """
         el = self.root.xpath('/cmdows/workflow/dataGraph')
         assert len(el) <= 1, '"/cmdows/workflow/dataGraph" is not a unique XPath. Check given CMDOWS file structure.'
         if el:
             el[0].getparent().remove(el[0])
 
     def remove_process_graph_element(self):
-        """Method to remove a processGraph element from a CMDOWS file."""
+        """Method to remove a processGraph element from a CMDOWS file.
+
+        :return: Schema without processGraph
+        :rtype: XMLSchema
+        """
         el = self.root.xpath('/cmdows/workflow/processGraph')
         assert len(el) <= 1, '"/cmdows/workflow/processGraph" is not a unique XPath. Check given CMDOWS file structure.'
         if el:
             el[0].getparent().remove(el[0])
 
     def remove_element_based_on_uid(self, uid, expected_tag=None):
-        """Method to remove an element based on its UID."""
+        """Method to remove an element based on its uID.
+
+        :param uid: uID of element to be removed
+        :type uid: basestring
+        :param expected_tag: (optional) the expected tag of the element
+        :type expected_tag: str
+        :return: Schema without element
+        :rtype: XMLSchema
+        """
         el = self.get_element_of_uid(uid)
         self.assert_element_tag(el, expected_tag)
         el.getparent().remove(el)
 
     def remove_element_based_on_xpath(self, xpath, expected_amount=None, expected_text=None, higher_level_removal=None):
-        """Method to remove an element based on its XPath."""
+        """Method to remove an element based on its XPath.
+
+        :param xpath: XPath of element to be removed
+        :type xpath: basestring
+        :param expected_amount: (optional) the expected amount of elements with this path
+        :type expected_amount: int
+        :param expected_text: (optional) the expected text of the element
+        :type expected_text: str
+        :param higher_level_removal: (optional) the amount of higher levels to be removed
+        :type higher_level_removal: int
+        :return: Schema without element
+        :rtype: XMLSchema
+        """
         els = self.root.xpath(xpath)
         if expected_amount:
             assert len(els) == expected_amount, '{} element(s) expected, found {}.'.format(expected_amount, len(els))
@@ -970,19 +1089,54 @@ class CMDOWS(object):
                 el_upper.remove(el)
 
     def remove_contact(self, contact_uid):
-        """Method to remove a contact based on its UID."""
+        """Method to remove a contact based on its uID.
+
+        :param contact_uid: uID of the contact to be removed
+        :type contact_uid: basestring
+        :return: Schema without contact
+        :rtype: XMLSchema
+        """
         self.remove_element_based_on_uid(contact_uid, expected_tag='contact')
 
     def remove_parameter(self, param_uid):
-        """Method to remove a parameter based on its UID."""
+        """Method to remove a parameter based on its uID.
+
+        :param param_uid: uID of parameter to be removed
+        :type param_uid: basestring
+        :return: Schema without parameter
+        :rtype: XMLSchema
+        """
         self.remove_element_based_on_uid(param_uid, expected_tag='parameter')
 
     def remove_parameters(self, params_uids):
-        """Method to remove a list of parameters based on their UID."""
+        """Method to remove a list of parameters based on their uID.
+
+        :param params_uid: uIDs of parameters to be removed
+        :type params_uids: list
+        :return: Schema without parameters listed
+        :rtype: XMLSchema
+        """
         for param_uid in params_uids:
             self.remove_element_based_on_uid(param_uid, expected_tag='parameter')
 
     def remove_actor(self, role, uid):
+        """Method to remove a role from the organization for a certain contact.
+
+        :param role: role to be removed from contact
+        :type role: str
+        :param uid: uID of contact
+        :type uid: basestring
+        :return: Organization branch without contact role
+        :rtype: XMLSchema
+
+        .. note:: Role options are:
+
+            * 'architect'
+            * 'integrator'
+            * 'collaborativeEngineer'
+            * 'toolSpecialist'
+            * 'customer'
+        """
         # Input assertions
         assert isinstance(role, basestring), 'Role should be of type string.'
         assert role in ['architect', 'integrator', 'collaborativeEngineer', 'toolSpecialist',
@@ -1001,7 +1155,31 @@ class CMDOWS(object):
     #             Export functions              #
     # ----------------------------------------- #
     def save(self, file_path=None, pretty_print=False, method='xml', xml_declaration=True, encoding='UTF-8'):
-        """Method to save a manipulated CMDOWS file"""
+        """Method to save a manipulated CMDOWS file.
+
+        :param file_path: file path of the CMDOWS
+        :type file_path: basestring
+        :param pretty_print: (optional)
+        :type pretty_print: bool
+        :param method: (optional) output method (see options below, default: "xml")
+        :type method: str
+        :param xml_declaration: (optional) addition of XML declaration to file
+        :type xml_declaration: bool
+        :param encoding: (optional) output encoding (see options below, default: "UTF-8")
+        :type encoding: str
+
+        .. note:: Output method options:
+
+            * "xml"
+            * "html"
+            * "text"
+            * "c14n"
+
+        .. note:: Output encoding options:
+
+            * "UTF-8"
+            * "US-ASCII"
+        """
         if file_path:
             file_path = file_path
         elif self.file:
diff --git a/kadmos/utilities/general.py b/kadmos/utilities/general.py
index 0af7b592b..08613247c 100644
--- a/kadmos/utilities/general.py
+++ b/kadmos/utilities/general.py
@@ -14,7 +14,16 @@ logger = logging.getLogger(__name__)
 
 
 def assert_dict_keys(dic, expected_keys, all_keys_required=False):
-    """Method to assert that a dictionary has the expected keys and (optionally) to check if is has all the keys."""
+    """Method to assert that a dictionary has the expected keys and (optionally) to check if is has all the keys.
+
+    :param dic: dictionary to checked
+    :type dic: dict
+    :param expected_keys: keys expected in dictionary
+    :type expected_keys: list
+    :param all_keys_required: (optional) to check if all keys are in the dictionary
+    :type all_keys_required: bool
+    :returns: check results
+    """
     assert isinstance(dic, dict), 'dic should be a dictionary.'
     dict_keys = dic.keys()
     if all_keys_required:
@@ -24,23 +33,32 @@ def assert_dict_keys(dic, expected_keys, all_keys_required=False):
 
 
 def dict_to_ord_dict(dic, key_order):
-    """Method to transform a Python dictionary into a Python ordered dictionary. Note that the key_order list can have
-    items that are not present in the given dictionary. All keys of the dictionary should be in the order though."""
+    """Method to transform a Python dictionary into a Python ordered dictionary.
+
+    :param dic: dictionary
+    :type dic: dict
+    :param key_order: order of the keys
+    :type key_order: list
+    :return: ordered dictionary
+    :rtype: OrderedDict
+
+    .. note:: the key_order list can have items that are not present in the given dictionary. All keys of the
+        dictionary should be in the order though.
+    """
     assert isinstance(dic, dict), 'dic should be of type dict.'
     assert isinstance(key_order, list), 'key_order should be of type list.'
     assert len(key_order) == len(set(key_order)), 'key_order should consist of unique elements.'
     ord_dict = OrderedDict()
     for key in key_order:
         if key in dic:
-            ord_dict.update({key:dic[key]})
+            ord_dict.update({key: dic[key]})
             del dic[key]
     assert not dic, 'Dictionary still contains elements with keys: {}'.format(dic.keys())
     return ord_dict
 
 
 def color_list():
-    """
-    A list of distinguisable colors.
+    """A list of distinguisable colors.
 
     :return: list with HTML Hex colors
     """
@@ -77,8 +95,7 @@ def color_list():
 
 
 def hex_to_rgb(value):
-    """
-    Function to translate a hex color string to an RGB color tuple.
+    """Function to translate a hex color string to an RGB color tuple.
 
     :param value: HTML hex color
     :type value: str
@@ -92,8 +109,7 @@ def hex_to_rgb(value):
 
 
 def get_uid(preference, uids):
-    """
-    Simple function to determine a valid uid which is not part of the uids list
+    """Simple function to determine a valid uid which is not part of the uids list
 
     :param preference: preferred name for the uid
     :type preference: str
@@ -116,8 +132,7 @@ def get_uid(preference, uids):
 
 
 def get_mdao_setup(mdao_setup):
-    """
-    Simple function to specify the MDAO architecture and convergence type based on a single string.
+    """Simple function to specify the MDAO architecture and convergence type based on a single string.
 
     :param mdao_setup: MDF-GS, MDF-J, IDF
     :type mdao_setup: str
@@ -425,7 +440,7 @@ def make_camel_case(string, make_plural_option=False):
     string = "".join(w.lower() if i is 0 else w.title() for i, w in enumerate(words))
 
     if string[-3:] == 'Uid':
-        string = string[:-3] + 'UID' # TODO: This can also be solved more generically.
+        string = string[:-3] + 'UID'  # TODO: This can also be solved more generically.
 
     if make_plural_option:
         string = make_plural(string)
@@ -440,7 +455,7 @@ def unmake_camel_case(string, separator='_'):
     :param string: camelCase string
     :type string: str
     :param separator: symbol/symbols used as separator
-    :type string: str
+    :type separator: str
     :return: string with separator
     :rtype: str
     """
@@ -469,7 +484,7 @@ def format_string_for_vistoms(string, prefix='', suffix=''):
     :return: formatted string
     :rtype: basestring
     """
-    replacement_list = ((' ', ''), ('_', '-'), ('[', ''), (']', ''),('.','-'))
+    replacement_list = ((' ', ''), ('_', '-'), ('[', ''), (']', ''), ('.', '-'))
     for repl in replacement_list:
         string = string.replace(repl[0], repl[1])
     return str(prefix) + string + str(suffix)
@@ -534,9 +549,12 @@ def remove_if_exists(input_list, entries_to_remove):
 
 
 def get_friendly_id(uid_length):
-    """
-    Create an ID string we can recognise.
-    (Think Italian or Japanese or Native American.)
+    """ Create a recognisable ID string.
+
+    :param uid_length: length of the ID
+    :type uid_length: int
+    :return: new ID
+    :rtype: str
     """
     v = 'aeiou'
     c = 'bdfghklmnprstvw'
@@ -544,8 +562,14 @@ def get_friendly_id(uid_length):
 
 
 def get_unique_friendly_id(used_ids, uid_length):
-    """
-    Return an ID that is not in our list of already used IDs.
+    """Return an ID that is not in our list of already used IDs.
+
+    :param used_ids: already used IDs
+    :type used_ids: list
+    :param uid_length: length of the ID
+    :type uid_length: int
+    :return: new unique ID
+    :rtype: str
     """
 
     # trying infinitely is a bad idea
@@ -617,8 +641,11 @@ def translate_list(l, dictionary):
     Utility to quickly translate all elements in a list with a dictionary.
 
     :param l: list to be translated
+    :type l: list
     :param dictionary: dictionary used for the translation
+    :type dictionary: dict
     :return: translated list
+    :rtype: list
     """
     translated = [dictionary.get(li, li) for li in l]
     return translated
@@ -629,8 +656,11 @@ def translate_dict_keys(dictionary, translations):
     Utility to (recursively) translate all keys in a dictionary with a translation dictionary.
 
     :param dictionary: dictionary to be translated
+    :type dictionary: dict
     :param translations: dictionary used for the translation
+    :type translations: dict
     :return: translated dictionary
+    :rtype: dict
     """
 
     for key, value in dictionary.iteritems():
@@ -645,17 +675,16 @@ def translate_dict_keys(dictionary, translations):
 
 
 def filter_group_vars(group_dict, current_group_idx, filter_setting):
-    """
-    Method to get the variables of a local group.
+    """Method to get the variables of a local/external group.
 
-    :param group_dict:
-    :type group_dict:
-    :param group_idx:
-    :type group_idx:
-    :param filter_setting:
-    :type filter_setting:
-    :return:
-    :rtype:
+    :param group_dict: local/external group
+    :type group_dict: dict
+    :param current_group_idx: index of the current group
+    :type current_group_idx: int
+    :param filter_setting: filter on 'local' or 'external' groups
+    :type filter_setting: list, string
+    :return: group variables
+    :rtype: list
     """
 
     if isinstance(filter_setting, list):
@@ -670,8 +699,7 @@ def filter_group_vars(group_dict, current_group_idx, filter_setting):
 
 
 def get_group_vars(sa, current_group_idx):
-    """
-    Method to get the variables with respect to t subgroup.
+    """Method to get the variables with respect to the subgroup.
 
     :param sa: system analysis dictionary
     :type sa: dict
@@ -683,7 +711,8 @@ def get_group_vars(sa, current_group_idx):
 
     global_des_vars_group = filter_group_vars(sa['des_vars']['groups'], current_group_idx, sa['des_vars']['global'])
     local_des_vars_group = filter_group_vars(sa['des_vars']['groups'], current_group_idx, sa['des_vars']['local'])
-    local_cnstrnt_vars_group = filter_group_vars(sa['constraints']['groups_vars'], current_group_idx, sa['constraints']['local_vars'])
+    local_cnstrnt_vars_group = filter_group_vars(sa['constraints']['groups_vars'], current_group_idx,
+                                                 sa['constraints']['local_vars'])
     local_group_couplings_group = filter_group_vars(sa['couplings']['groups'], current_group_idx, 'local')
     external_group_couplings_group = filter_group_vars(sa['couplings']['groups'], current_group_idx, 'external')
 
@@ -692,8 +721,12 @@ def get_group_vars(sa, current_group_idx):
 
 
 def convert_bytes(num):
-    """
-    this function will convert bytes to MB.... GB... etc
+    """Function to convert bytes to  KB, MB, GB, TB.
+
+    :param num: number of bytes
+    :type num: int
+    :return: converted number
+    :rtype: str
     """
     for x in ['bytes', 'KB', 'MB', 'GB', 'TB']:
         if num < 1024.0:
@@ -702,8 +735,13 @@ def convert_bytes(num):
 
 
 def file_size(file_path):
-    """
-    this function will return the file size
+    """Function to return the file size.
+
+    :param file_path: file path
+    :type file_path: str
+    :return: file size
+    :rtype: str
+
     """
     if os.path.isfile(file_path):
         file_info = os.stat(file_path)
@@ -713,12 +751,16 @@ def file_size(file_path):
 
 
 def file_size_MB(file_path):
-    """
-    this function will return the file size
+    """Function to return the file size in MB.
+
+    :param file_path: file path
+    :type file_path: str
+    :return: file size in MB
+    :rtype: float
     """
     if os.path.isfile(file_path):
         file_info = os.stat(file_path)
-        return file_info.st_size/1024.0/1024.0
+        return file_info.st_size / 1024.0 / 1024.0
     else:
         raise IOError('Could not find file: {}'.format(file_path))
 
-- 
GitLab