Skip to content

Commit

Permalink
fixed version naming and refreshed documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@FDonati
FDonati committed Apr 3, 2020
1 parent 87e09c8 commit 68f1be6
Show file tree
Hide file tree
Showing 57 changed files with 2,034 additions and 2,555 deletions.
Binary file modified docs/_build/doctrees/authors.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/contributing.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/history.doctree
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/installation.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/modules.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/pycirk.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/readme.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/usage.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d6fa29c12a3539fe59921482cb73f252
config: 32d434fc321b4f2ced7d28506d7c6b3b
tags: 645f666f9bcd5a90fca523b33c5a78b7
15 changes: 6 additions & 9 deletions docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta charset="utf-8" />
<title>Overview: module code &#8212; pycirk 1.5.0 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />

Expand Down Expand Up @@ -80,13 +79,11 @@ <h3>Related Topics</h3>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
Expand All @@ -107,7 +104,7 @@ <h3>Quick search</h3>
&copy;2019, Franco Donati.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>
Expand Down
45 changes: 19 additions & 26 deletions docs/_build/html/_modules/pycirk/fundamental_operations.html
View file

Large diffs are not rendered by default.

64 changes: 33 additions & 31 deletions docs/_build/html/_modules/pycirk/labels.html
View file

Large diffs are not rendered by default.

157 changes: 25 additions & 132 deletions docs/_build/html/_modules/pycirk/make_scenarios.html
View file

Large diffs are not rendered by default.

28 changes: 13 additions & 15 deletions docs/_build/html/_modules/pycirk/make_secondary_flows.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta charset="utf-8" />
<title>pycirk.make_secondary_flows &#8212; pycirk 1.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />

Expand Down Expand Up @@ -124,6 +123,7 @@ <h1>Source code for pycirk.make_secondary_flows</h1><div class="highlight"><pre>
<span class="n">V</span> <span class="o">=</span> <span class="n">V</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">U</span> <span class="o">=</span> <span class="n">U</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">Y</span> <span class="o">=</span> <span class="n">Y</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>


<span class="c1"># position of the secondary material</span>
<span class="n">des_prod_ix_pos</span> <span class="o">=</span> <span class="n">prod_or</span> <span class="o">+</span> <span class="mi">1</span>
Expand All @@ -132,7 +132,7 @@ <h1>Source code for pycirk.make_secondary_flows</h1><div class="highlight"><pre>
<span class="c1"># getting the value of secondary material from the supply table</span>
<span class="c1"># which is placed on the primary material row</span>
<span class="n">misplaced</span> <span class="o">=</span> <span class="n">V</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">prod_or</span><span class="p">,</span> <span class="n">des_ind_col_pos</span><span class="p">]</span>

<span class="c1"># placing the misplaced value to the secondary material row</span>
<span class="n">V</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">des_prod_ix_pos</span><span class="p">,</span> <span class="n">des_ind_col_pos</span><span class="p">]</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">misplaced</span><span class="p">)</span>

Expand Down Expand Up @@ -165,17 +165,17 @@ <h1>Source code for pycirk.make_secondary_flows</h1><div class="highlight"><pre>

<span class="n">eye</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">identity</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">ratio_prim_sec</span><span class="p">))</span>

<span class="n">U</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">prod_or</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">eye</span> <span class="o">-</span> <span class="n">ratio_prim_sec</span><span class="p">)</span> <span class="o">@</span> <span class="n">prim_sec_use_trans</span>
<span class="n">U</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">prod_or</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">eye</span> <span class="o">-</span> <span class="n">ratio_prim_sec</span><span class="p">)</span> <span class="o">@</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">prim_sec_use_trans</span><span class="p">)</span>

<span class="n">U</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">des_prod_ix_pos</span><span class="p">]</span> <span class="o">=</span> <span class="n">ratio_prim_sec</span> <span class="o">@</span> <span class="n">prim_sec_use_trans</span>
<span class="n">U</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">des_prod_ix_pos</span><span class="p">]</span> <span class="o">=</span> <span class="n">ratio_prim_sec</span> <span class="o">@</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">prim_sec_use_trans</span><span class="p">)</span>

<span class="n">Y</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">prod_or</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">eye</span> <span class="o">-</span> <span class="n">ratio_prim_sec</span><span class="p">)</span> <span class="o">@</span> <span class="n">prim_sec_fin_dem_trans</span>
<span class="n">Y</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">prod_or</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">eye</span> <span class="o">-</span> <span class="n">ratio_prim_sec</span><span class="p">)</span> <span class="o">@</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">prim_sec_fin_dem_trans</span><span class="p">)</span>

<span class="n">Y</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">des_prod_ix_pos</span><span class="p">]</span> <span class="o">=</span> <span class="n">ratio_prim_sec</span> <span class="o">@</span> <span class="n">prim_sec_fin_dem_trans</span>
<span class="n">Y</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">des_prod_ix_pos</span><span class="p">]</span> <span class="o">=</span> <span class="n">ratio_prim_sec</span> <span class="o">@</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">prim_sec_fin_dem_trans</span><span class="p">)</span>

<span class="n">V</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">prod_or</span><span class="p">,</span> <span class="n">des_ind_col_pos</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span>

<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;splitting off secondary materials ready&#39;</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">&#39;splitting off secondary materials completed&#39;</span><span class="p">)</span>

<span class="k">return</span> <span class="p">{</span><span class="s2">&quot;V&quot;</span><span class="p">:</span> <span class="n">V</span><span class="p">,</span>
<span class="s2">&quot;U&quot;</span><span class="p">:</span> <span class="n">U</span><span class="p">,</span>
Expand Down Expand Up @@ -219,13 +219,11 @@ <h3>Related Topics</h3>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
Expand All @@ -246,7 +244,7 @@ <h3>Quick search</h3>
&copy;2019, Franco Donati.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>
Expand Down
42 changes: 20 additions & 22 deletions docs/_build/html/_modules/pycirk/organize_io.html
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta charset="utf-8" />
<title>pycirk.organize_io &#8212; pycirk 1.5.0 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<script type="text/javascript" src="../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />

Expand Down Expand Up @@ -45,22 +44,23 @@ <h1>Source code for pycirk.organize_io</h1><div class="highlight"><pre>
<span class="sd">@institution: Leiden University CML</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>

<div class="viewcode-block" id="organizer"><a class="viewcode-back" href="../../pycirk.html#pycirk.organize_io.organizer">[docs]</a><span class="k">def</span> <span class="nf">organizer</span><span class="p">(</span><span class="n">data</span><span class="p">):</span>

<span class="k">return</span> <span class="p">{</span><span class="s2">&quot;Z&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;Z&quot;</span><span class="p">],</span>
<span class="s2">&quot;Y&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;Y&quot;</span><span class="p">],</span>
<span class="s2">&quot;W&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;W&quot;</span><span class="p">],</span>
<span class="s2">&quot;E&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;E&quot;</span><span class="p">],</span>
<span class="s2">&quot;R&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;R&quot;</span><span class="p">],</span>
<span class="s2">&quot;M&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;M&quot;</span><span class="p">],</span>
<span class="s2">&quot;EY&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;EY&quot;</span><span class="p">],</span>
<span class="s2">&quot;RY&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;RY&quot;</span><span class="p">],</span>
<span class="s2">&quot;MY&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;MY&quot;</span><span class="p">],</span>
<span class="s2">&quot;Cr_E_k&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;Cr_E_k&quot;</span><span class="p">],</span>
<span class="s2">&quot;Cr_M_k&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;Cr_M_k&quot;</span><span class="p">],</span>
<span class="s2">&quot;Cr_R_k&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;Cr_R_k&quot;</span><span class="p">],</span>
<span class="s2">&quot;Cr_W_k&quot;</span><span class="p">:</span> <span class="n">data</span><span class="p">[</span><span class="s2">&quot;Cr_W_k&quot;</span><span class="p">]</span>
<span class="k">return</span> <span class="p">{</span><span class="s2">&quot;Z&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;Z&quot;</span><span class="p">]),</span>
<span class="s2">&quot;Y&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;Y&quot;</span><span class="p">]),</span>
<span class="s2">&quot;W&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;W&quot;</span><span class="p">]),</span>
<span class="s2">&quot;E&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;E&quot;</span><span class="p">]),</span>
<span class="s2">&quot;R&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;R&quot;</span><span class="p">]),</span>
<span class="s2">&quot;M&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;M&quot;</span><span class="p">]),</span>
<span class="s2">&quot;EY&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;EY&quot;</span><span class="p">]),</span>
<span class="s2">&quot;RY&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;RY&quot;</span><span class="p">]),</span>
<span class="s2">&quot;MY&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;MY&quot;</span><span class="p">]),</span>
<span class="s2">&quot;Cr_E_k&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;Cr_E_k&quot;</span><span class="p">]),</span>
<span class="s2">&quot;Cr_M_k&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;Cr_M_k&quot;</span><span class="p">]),</span>
<span class="s2">&quot;Cr_R_k&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;Cr_R_k&quot;</span><span class="p">]),</span>
<span class="s2">&quot;Cr_W_k&quot;</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;Cr_W_k&quot;</span><span class="p">])</span>
<span class="p">}</span></div>
</pre></div>

Expand Down Expand Up @@ -101,13 +101,11 @@ <h3>Related Topics</h3>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
Expand All @@ -128,7 +126,7 @@ <h3>Quick search</h3>
&copy;2019, Franco Donati.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>
Expand Down
Loading

0 comments on commit 68f1be6

Please sign in to comment.