Skip to content

Commit

Permalink
fixing doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@wisaaco
wisaaco committed Sep 2, 2019
1 parent 50a46d7 commit 6e281c2
Show file tree
Hide file tree
Showing 23 changed files with 489 additions and 131 deletions.
Binary file modified docs/build/doctrees/api_reference/yafs.application.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/api_reference/yafs.core.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/api_reference/yafs.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/api_reference/yafs.selection.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/build/doctrees/introduction/basic.doctree
View file
Binary file not shown.
302 changes: 260 additions & 42 deletions docs/build/html/_modules/yafs/core.html
View file

Large diffs are not rendered by default.

29 changes: 13 additions & 16 deletions docs/build/html/_modules/yafs/placement.html
View file
Expand Up @@ -112,18 +112,14 @@ <h1>Source code for yafs.placement</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">json</span>

<span class="k">def</span> <span class="nf">initial_allocation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">app_name</span><span class="p">):</span>

<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;initialAllocation&quot;</span><span class="p">]:</span>
<span class="c1">#print item</span>
<span class="n">app_name</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;app&quot;</span><span class="p">]</span>
<span class="n">module</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;module_name&quot;</span><span class="p">]</span>
<span class="n">idtopo</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;id_resource&quot;</span><span class="p">]</span>

<span class="n">app</span> <span class="o">=</span> <span class="n">sim</span><span class="o">.</span><span class="n">apps</span><span class="p">[</span><span class="n">app_name</span><span class="p">]</span>
<span class="n">services</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">services</span>
<span class="c1">#print services[module]</span>
<span class="n">idDES</span> <span class="o">=</span> <span class="n">sim</span><span class="o">.</span><span class="n">deploy_module</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">module</span><span class="p">,</span> <span class="n">services</span><span class="p">[</span><span class="n">module</span><span class="p">],[</span><span class="n">idtopo</span><span class="p">])</span>

<span class="k">if</span> <span class="n">app_name</span> <span class="o">==</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;app&quot;</span><span class="p">]:</span>
<span class="c1"># app_name = item[&quot;app&quot;]</span>
<span class="n">module</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;module_name&quot;</span><span class="p">]</span>
<span class="n">idtopo</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;id_resource&quot;</span><span class="p">]</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">sim</span><span class="o">.</span><span class="n">apps</span><span class="p">[</span><span class="n">app_name</span><span class="p">]</span>
<span class="n">services</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">services</span>
<span class="n">idDES</span> <span class="o">=</span> <span class="n">sim</span><span class="o">.</span><span class="n">deploy_module</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">module</span><span class="p">,</span> <span class="n">services</span><span class="p">[</span><span class="n">module</span><span class="p">],[</span><span class="n">idtopo</span><span class="p">])</span>


<span class="k">class</span> <span class="nc">JSONPlacementOnCloud</span><span class="p">(</span><span class="n">Placement</span><span class="p">):</span>
Expand All @@ -135,12 +131,13 @@ <h1>Source code for yafs.placement</h1><div class="highlight"><pre>
<span class="k">def</span> <span class="nf">initial_allocation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">app_name</span><span class="p">):</span>

<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;initialAllocation&quot;</span><span class="p">]:</span>
<span class="n">app_name</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;app&quot;</span><span class="p">]</span>
<span class="n">module</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;module_name&quot;</span><span class="p">]</span>
<span class="k">if</span> <span class="n">app_name</span> <span class="o">==</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;app&quot;</span><span class="p">]:</span>
<span class="n">app_name</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;app&quot;</span><span class="p">]</span>
<span class="n">module</span> <span class="o">=</span> <span class="n">item</span><span class="p">[</span><span class="s2">&quot;module_name&quot;</span><span class="p">]</span>

<span class="n">app</span> <span class="o">=</span> <span class="n">sim</span><span class="o">.</span><span class="n">apps</span><span class="p">[</span><span class="n">app_name</span><span class="p">]</span>
<span class="n">services</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">services</span>
<span class="n">idDES</span> <span class="o">=</span> <span class="n">sim</span><span class="o">.</span><span class="n">deploy_module</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">module</span><span class="p">,</span> <span class="n">services</span><span class="p">[</span><span class="n">module</span><span class="p">],[</span><span class="bp">self</span><span class="o">.</span><span class="n">idCloud</span><span class="p">])</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">sim</span><span class="o">.</span><span class="n">apps</span><span class="p">[</span><span class="n">app_name</span><span class="p">]</span>
<span class="n">services</span> <span class="o">=</span> <span class="n">app</span><span class="o">.</span><span class="n">services</span>
<span class="n">idDES</span> <span class="o">=</span> <span class="n">sim</span><span class="o">.</span><span class="n">deploy_module</span><span class="p">(</span><span class="n">app_name</span><span class="p">,</span> <span class="n">module</span><span class="p">,</span> <span class="n">services</span><span class="p">[</span><span class="n">module</span><span class="p">],[</span><span class="bp">self</span><span class="o">.</span><span class="n">idCloud</span><span class="p">])</span>



Expand Down
29 changes: 16 additions & 13 deletions docs/build/html/_modules/yafs/selection.html
View file
Expand Up @@ -65,19 +65,21 @@ <h1>Source code for yafs.selection</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">lat_acc</span> <span class="o">=</span> <span class="mf">0.0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">propagation</span> <span class="o">=</span> <span class="mf">0.0</span>

<div class="viewcode-block" id="Selection.get_path"><a class="viewcode-back" href="../../api_reference/yafs.selection.html#yafs.selection.Selection.get_path">[docs]</a> <span class="k">def</span> <span class="nf">get_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">app_name</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">topology_src</span><span class="p">,</span><span class="n">alloc_DES</span><span class="p">,</span> <span class="n">alloc_module</span><span class="p">,</span> <span class="n">traffic</span><span class="p">):</span>
<div class="viewcode-block" id="Selection.get_path"><a class="viewcode-back" href="../../api_reference/yafs.selection.html#yafs.selection.Selection.get_path">[docs]</a> <span class="k">def</span> <span class="nf">get_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">app_name</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">topology_src</span><span class="p">,</span><span class="n">alloc_DES</span><span class="p">,</span> <span class="n">alloc_module</span><span class="p">,</span> <span class="n">traffic</span><span class="p">,</span> <span class="n">from_des</span><span class="p">):</span>

<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Args:</span>

<span class="sd"> sim (yafs.core.Sim)</span>

<span class="sd"> src (int): the node source</span>

<span class="sd"> dst (dst): the node destiny</span>

<span class="sd"> message (yafs.application.Message)</span>

<span class="sd"> traffic (dict): the current occupation of the network</span>
<span class="sd"> :param sim:</span>
<span class="sd"> :param message:</span>
<span class="sd"> :param link:</span>
<span class="sd"> :param alloc_DES:</span>
<span class="sd"> :param alloc_module:</span>
<span class="sd"> :param traffic:</span>
<span class="sd"> :param ctime:</span>
<span class="sd"> :param from_des</span>
<span class="sd"> :return:</span>
<span class="sd"> both empty arrays implies that the message will not send to the destination.</span>

<span class="sd"> Returns:</span>

Expand All @@ -96,7 +98,7 @@ <h1>Source code for yafs.selection</h1><div class="highlight"><pre>
<span class="sd">&quot;&quot;&quot; END Selection &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">path</span><span class="p">,</span><span class="n">ids</span></div>

<div class="viewcode-block" id="Selection.get_path_from_failure"><a class="viewcode-back" href="../../api_reference/yafs.selection.html#yafs.selection.Selection.get_path_from_failure">[docs]</a> <span class="k">def</span> <span class="nf">get_path_from_failure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">link</span><span class="p">,</span> <span class="n">alloc_DES</span><span class="p">,</span> <span class="n">alloc_module</span><span class="p">,</span> <span class="n">traffic</span><span class="p">,</span> <span class="n">ctime</span><span class="p">):</span>
<div class="viewcode-block" id="Selection.get_path_from_failure"><a class="viewcode-back" href="../../api_reference/yafs.selection.html#yafs.selection.Selection.get_path_from_failure">[docs]</a> <span class="k">def</span> <span class="nf">get_path_from_failure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">link</span><span class="p">,</span> <span class="n">alloc_DES</span><span class="p">,</span> <span class="n">alloc_module</span><span class="p">,</span> <span class="n">traffic</span><span class="p">,</span> <span class="n">ctime</span><span class="p">,</span> <span class="n">from_des</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This function is call when some link of a message path is broken or unavailable. A new one from that point should be calculated.</span>

Expand All @@ -107,6 +109,7 @@ <h1>Source code for yafs.selection</h1><div class="highlight"><pre>
<span class="sd"> :param alloc_module:</span>
<span class="sd"> :param traffic:</span>
<span class="sd"> :param ctime:</span>
<span class="sd"> :param from_des</span>
<span class="sd"> :return:</span>
<span class="sd"> both empty arrays implies that the message will not send to the destination.</span>

Expand All @@ -124,7 +127,7 @@ <h1>Source code for yafs.selection</h1><div class="highlight"><pre>
<span class="sd"> Among all the possible options, it returns a random path.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">get_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">app_name</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">topology_src</span><span class="p">,</span><span class="n">alloc_DES</span><span class="p">,</span> <span class="n">alloc_module</span><span class="p">,</span> <span class="n">traffic</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">get_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">app_name</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">topology_src</span><span class="p">,</span><span class="n">alloc_DES</span><span class="p">,</span> <span class="n">alloc_module</span><span class="p">,</span> <span class="n">traffic</span><span class="p">,</span><span class="n">from_des</span><span class="p">):</span>
<span class="n">paths</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">dst_idDES</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">src_node</span> <span class="o">=</span> <span class="n">topology_src</span>
Expand All @@ -142,7 +145,7 @@ <h1>Source code for yafs.selection</h1><div class="highlight"><pre>
<div class="viewcode-block" id="First_ShortestPath"><a class="viewcode-back" href="../../api_reference/yafs.selection.html#yafs.selection.First_ShortestPath">[docs]</a><span class="k">class</span> <span class="nc">First_ShortestPath</span><span class="p">(</span><span class="n">Selection</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Among all possible shorter paths, returns the first.&quot;&quot;&quot;</span>

<span class="k">def</span> <span class="nf">get_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">app_name</span><span class="p">,</span><span class="n">message</span><span class="p">,</span> <span class="n">topology_src</span><span class="p">,</span> <span class="n">alloc_DES</span><span class="p">,</span> <span class="n">alloc_module</span><span class="p">,</span> <span class="n">traffic</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">get_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sim</span><span class="p">,</span> <span class="n">app_name</span><span class="p">,</span><span class="n">message</span><span class="p">,</span> <span class="n">topology_src</span><span class="p">,</span> <span class="n">alloc_DES</span><span class="p">,</span> <span class="n">alloc_module</span><span class="p">,</span> <span class="n">traffic</span><span class="p">,</span><span class="n">from_des</span><span class="p">):</span>
<span class="n">paths</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">dst_idDES</span> <span class="o">=</span> <span class="p">[]</span>

Expand Down

0 comments on commit 6e281c2

Please sign in to comment.