Skip to content

Commit 0e32a34

Browse files
committed
updated documentation and tutorials to v7.20
1 parent 4132450 commit 0e32a34

File tree

141 files changed

+215141
-10263
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

141 files changed

+215141
-10263
lines changed

cbmpy-docs/html/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config:
4+
tags:

cbmpy-docs/html/_modules/cbmpy/CBCPLEX.html

Lines changed: 2169 additions & 0 deletions
Large diffs are not rendered by default.

cbmpy-docs/html/_modules/cbmpy/CBCommon.html

Lines changed: 591 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
5+
<html xmlns="http://www.w3.org/1999/xhtml">
6+
<head>
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
<title>cbmpy.CBConfig &#8212; CBMPy 0.7.20 documentation</title>
9+
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
10+
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
11+
<script type="text/javascript">
12+
var DOCUMENTATION_OPTIONS = {
13+
URL_ROOT: '../../',
14+
VERSION: '0.7.20',
15+
COLLAPSE_INDEX: false,
16+
FILE_SUFFIX: '.html',
17+
HAS_SOURCE: true,
18+
SOURCELINK_SUFFIX: '.txt'
19+
};
20+
</script>
21+
<script type="text/javascript" src="../../_static/jquery.js"></script>
22+
<script type="text/javascript" src="../../_static/underscore.js"></script>
23+
<script type="text/javascript" src="../../_static/doctools.js"></script>
24+
<link rel="search" type="application/opensearchdescription+xml"
25+
title="Search within CBMPy 0.7.20 documentation"
26+
href="../../_static/opensearch.xml"/>
27+
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
28+
<link rel="index" title="Index" href="../../genindex.html" />
29+
<link rel="search" title="Search" href="../../search.html" />
30+
31+
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
32+
33+
34+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
35+
36+
</head>
37+
<body>
38+
39+
40+
<div class="document">
41+
<div class="documentwrapper">
42+
<div class="bodywrapper">
43+
<div class="body" role="main">
44+
45+
<h1>Source code for cbmpy.CBConfig</h1><div class="highlight"><pre>
46+
<span></span><span class="sd">&quot;&quot;&quot;</span>
47+
<span class="sd">CBMPy: CBConfig module</span>
48+
<span class="sd">======================</span>
49+
<span class="sd">PySCeS Constraint Based Modelling (http://cbmpy.sourceforge.net)</span>
50+
<span class="sd">Copyright (C) 2009-2017 Brett G. Olivier, VU University Amsterdam, Amsterdam, The Netherlands</span>
51+
52+
<span class="sd">This program is free software: you can redistribute it and/or modify</span>
53+
<span class="sd">it under the terms of the GNU General Public License as published by</span>
54+
<span class="sd">the Free Software Foundation, either version 3 of the License, or</span>
55+
<span class="sd">(at your option) any later version.</span>
56+
57+
<span class="sd">This program is distributed in the hope that it will be useful,</span>
58+
<span class="sd">but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
59+
<span class="sd">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
60+
<span class="sd">GNU General Public License for more details.</span>
61+
62+
<span class="sd">You should have received a copy of the GNU General Public License</span>
63+
<span class="sd">along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;</span>
64+
65+
<span class="sd">Author: Brett G. Olivier</span>
66+
<span class="sd">Contact email: [email protected]</span>
67+
<span class="sd">Last edit: $Author: bgoli $ ($Id: CBConfig.py 637 2017-12-15 11:34:59Z bgoli $)</span>
68+
69+
<span class="sd">&quot;&quot;&quot;</span>
70+
<span class="c1">## gets rid of &quot;invalid variable name&quot; info</span>
71+
<span class="c1"># pylint: disable=C0103</span>
72+
<span class="c1">## gets rid of &quot;line to long&quot; info</span>
73+
<span class="c1"># pylint: disable=C0301</span>
74+
<span class="c1">## use with caution: gets rid of module xxx has no member errors (run once enabled)</span>
75+
<span class="c1"># pylint: disable=E1101</span>
76+
77+
<span class="c1"># preparing for Python 3 port</span>
78+
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">division</span><span class="p">,</span> <span class="n">print_function</span>
79+
<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">absolute_import</span>
80+
<span class="c1">#from __future__ import unicode_literals</span>
81+
82+
<span class="c1"># release</span>
83+
84+
<span class="k">try</span><span class="p">:</span>
85+
<span class="n">STATUS</span> <span class="o">=</span> <span class="s1">&#39;$Rev: 637 $&#39;</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;Rev: &#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;$&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
86+
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
87+
<span class="n">STATUS</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
88+
89+
<span class="n">__CBCONFIG__</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;VERSION_MAJOR&#39;</span> <span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
90+
<span class="s1">&#39;VERSION_MINOR&#39;</span> <span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
91+
<span class="s1">&#39;VERSION_MICRO&#39;</span> <span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
92+
<span class="s1">&#39;VERSION_STATUS&#39;</span> <span class="p">:</span> <span class="n">STATUS</span><span class="p">,</span>
93+
<span class="s1">&#39;VERSION&#39;</span> <span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
94+
<span class="s1">&#39;DEBUG&#39;</span> <span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
95+
<span class="s1">&#39;SOLVER_PREF&#39;</span> <span class="p">:</span> <span class="s1">&#39;CPLEX&#39;</span><span class="p">,</span>
96+
<span class="c1">#&#39;SOLVER_PREF&#39; : &#39;GLPK&#39;,</span>
97+
<span class="s1">&#39;SOLVER_ACTIVE&#39;</span> <span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
98+
<span class="s1">&#39;REVERSIBLE_SYMBOL&#39;</span> <span class="p">:</span> <span class="s1">&#39;&lt;==&gt;&#39;</span><span class="p">,</span>
99+
<span class="s1">&#39;IRREVERSIBLE_SYMBOL&#39;</span> <span class="p">:</span> <span class="s1">&#39;--&gt;&#39;</span><span class="p">,</span>
100+
<span class="s1">&#39;HAVE_SBML2&#39;</span> <span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
101+
<span class="s1">&#39;HAVE_SBML3&#39;</span> <span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
102+
<span class="s1">&#39;CBMPY_DIR&#39;</span> <span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
103+
<span class="s1">&#39;CBMPY_CGLPK_VER&#39;</span> <span class="p">:</span> <span class="s1">&#39;w452&#39;</span><span class="p">,</span>
104+
<span class="s1">&#39;SYMPY_DENOM_LIMIT&#39;</span> <span class="p">:</span> <span class="mi">10</span><span class="o">**</span><span class="mi">32</span>
105+
<span class="p">}</span>
106+
107+
<div class="viewcode-block" id="current_version"><a class="viewcode-back" href="../../modules_doc.html#cbmpy.CBConfig.current_version">[docs]</a><span class="k">def</span> <span class="nf">current_version</span><span class="p">():</span>
108+
<span class="sd">&quot;&quot;&quot;</span>
109+
<span class="sd"> Return the current CBMPy version as a string</span>
110+
111+
<span class="sd"> &quot;&quot;&quot;</span>
112+
<span class="c1">#return &#39;%s.%s.%s [r%s]&#39; % (__CBCONFIG__[&#39;VERSION_MAJOR&#39;], __CBCONFIG__[&#39;VERSION_MINOR&#39;], __CBCONFIG__[&#39;VERSION_MICRO&#39;], __CBCONFIG__[&#39;VERSION_STATUS&#39;])</span>
113+
<span class="k">if</span> <span class="n">STATUS</span> <span class="o">==</span> <span class="s1">&#39;&#39;</span><span class="p">:</span>
114+
<span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1">.</span><span class="si">{}</span><span class="s1">.</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MAJOR&#39;</span><span class="p">],</span> <span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MINOR&#39;</span><span class="p">],</span> <span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MICRO&#39;</span><span class="p">])</span>
115+
<span class="k">else</span><span class="p">:</span>
116+
<span class="k">return</span> <span class="s1">&#39;</span><span class="si">{}</span><span class="s1">.</span><span class="si">{}</span><span class="s1">.</span><span class="si">{}</span><span class="s1">.</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MAJOR&#39;</span><span class="p">],</span> <span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MINOR&#39;</span><span class="p">],</span> <span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MICRO&#39;</span><span class="p">],</span> <span class="n">STATUS</span><span class="p">)</span></div>
117+
118+
<div class="viewcode-block" id="current_version_tuple"><a class="viewcode-back" href="../../modules_doc.html#cbmpy.CBConfig.current_version_tuple">[docs]</a><span class="k">def</span> <span class="nf">current_version_tuple</span><span class="p">():</span>
119+
<span class="sd">&quot;&quot;&quot;</span>
120+
<span class="sd"> Return the current CBMPy version as a tuple (x, y, z)</span>
121+
122+
<span class="sd"> &quot;&quot;&quot;</span>
123+
<span class="k">return</span> <span class="p">(</span><span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MAJOR&#39;</span><span class="p">],</span> <span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MINOR&#39;</span><span class="p">],</span> <span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION_MICRO&#39;</span><span class="p">])</span></div>
124+
125+
<span class="n">__CBCONFIG__</span><span class="p">[</span><span class="s1">&#39;VERSION&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">current_version</span><span class="p">()</span>
126+
127+
128+
</pre></div>
129+
130+
</div>
131+
</div>
132+
</div>
133+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
134+
<div class="sphinxsidebarwrapper">
135+
<p class="logo"><a href="../../cbmpy.html">
136+
<img class="logo" src="../../_static/pysces_cbm1_head.jpg" alt="Logo"/>
137+
</a></p><div class="relations">
138+
<h3>Related Topics</h3>
139+
<ul>
140+
<li><a href="../../cbmpy.html">Documentation overview</a><ul>
141+
<li><a href="../index.html">Module code</a><ul>
142+
</ul></li>
143+
</ul></li>
144+
</ul>
145+
</div>
146+
<div id="searchbox" style="display: none" role="search">
147+
<h3>Quick search</h3>
148+
<form class="search" action="../../search.html" method="get">
149+
<div><input type="text" name="q" /></div>
150+
<div><input type="submit" value="Go" /></div>
151+
<input type="hidden" name="check_keywords" value="yes" />
152+
<input type="hidden" name="area" value="default" />
153+
</form>
154+
</div>
155+
<script type="text/javascript">$('#searchbox').show(0);</script>
156+
</div>
157+
</div>
158+
<div class="clearer"></div>
159+
</div>
160+
<div class="footer">
161+
&copy;2010-2018, Brett G. Olivier.
162+
163+
|
164+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
165+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
166+
167+
</div>
168+
169+
170+
171+
172+
</body>
173+
</html>

0 commit comments

Comments
 (0)