diff --git a/doc/html/_modules/index.html b/doc/html/_modules/index.html index 761fe5c65208c68dab8e37156eb839f729a21ee2..cb7a1cc662e84d8c42c40c6eab7c48ae2d45ef31 100644 --- a/doc/html/_modules/index.html +++ b/doc/html/_modules/index.html @@ -52,6 +52,7 @@ <ul><li><a href="promod3.html">promod3</a></li> <ul><li><a href="promod3/core/argcheck.html">promod3.core.argcheck</a></li> <li><a href="promod3/core/helper.html">promod3.core.helper</a></li> +<li><a href="promod3/core/pm3argparse.html">promod3.core.pm3argparse</a></li> <li><a href="promod3/rawmodel/_rawmodel.html">promod3.rawmodel._rawmodel</a></li> </ul><li><a href="test_actions.html">test_actions</a></li> </ul> diff --git a/doc/html/_modules/promod3/core/pm3argparse.html b/doc/html/_modules/promod3/core/pm3argparse.html new file mode 100644 index 0000000000000000000000000000000000000000..bb6d26da2c4741822d40696fdb00b138912a939a --- /dev/null +++ b/doc/html/_modules/promod3/core/pm3argparse.html @@ -0,0 +1,169 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>promod3.core.pm3argparse — ProMod3 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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../../../', + VERSION: '0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </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> + <link rel="top" title="ProMod3 0 documentation" href="../../../index.html" /> + <link rel="up" title="promod3" href="../../promod3.html" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + </head> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../../../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../../../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="nav-item nav-item-0"><a href="../../../index.html">ProMod3 0 documentation</a> »</li> + <li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li> + <li class="nav-item nav-item-2"><a href="../../promod3.html" accesskey="U">promod3</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <h1>Source code for promod3.core.pm3argparse</h1><div class="highlight"><pre> +<span class="sd">"""</span> +<span class="sd">Extensions for the argparse module.</span> +<span class="sd">"""</span> + +<span class="kn">import</span> <span class="nn">argparse</span> +<span class="kn">import</span> <span class="nn">sys</span> +<span class="kn">import</span> <span class="nn">os</span> + +<div class="viewcode-block" id="PM3ArgumentParser"><a class="viewcode-back" href="../../../core/pm3argparse.html#promod3.core.pm3argparse.PM3ArgumentParser">[docs]</a><span class="k">class</span> <span class="nc">PM3ArgumentParser</span><span class="p">(</span><span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> This class is a child of :class:`argparse.ArgumentParser`. It provides a</span> +<span class="sd"> set of standard arguments which can be activated, rather than added via the</span> +<span class="sd"> traditional way. This helps keeping up a common naming scheme throughout</span> +<span class="sd"> all |project| actions. As a real extension, this subclass provides checking</span> +<span class="sd"> of input parameters on :meth:`~pm3argparse.PM3ArgumentParser.Parse`. Beside</span> +<span class="sd"> this, everything you can do with a 'real' :class:`~argparse.ArgumentParser`</span> +<span class="sd"> instance is possible here.</span> + +<span class="sd"> A note on exit codes: if :meth:`~pm3argparse.PM3ArgumentParser.Parse` is</span> +<span class="sd"> called on unrecognised arguments, the script exits with a code 2 by</span> +<span class="sd"> :class:`argparse.ArgumentParser.parse_args()`.</span> + +<span class="sd"> Attributes beyond :class:`argparse.ArgumentParser`:</span> + +<span class="sd"> .. attribute:: action</span> + +<span class="sd"> Indicates if the calling script is a |project| action.</span> + +<span class="sd"> :type: :class:`bool`</span> +<span class="sd"> """</span> +<div class="viewcode-block" id="PM3ArgumentParser.__init__"><a class="viewcode-back" href="../../../core/pm3argparse.html#promod3.core.pm3argparse.PM3ArgumentParser.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">description</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Create a new instance of :class:`~pm3argparse.PM3ArgumentParser`.</span> + +<span class="sd"> :param action: Indicates if the calling script is a |project| action.</span> +<span class="sd"> This influences |progattr|_ of</span> +<span class="sd"> :class:`~argparse.ArgumentParser` by clipping of the</span> +<span class="sd"> first 3 characters of the file name of the script. If</span> +<span class="sd"> ``False``, default behaviour of</span> +<span class="sd"> :class:`~argparse.ArgumentParser` kicks in.</span> +<span class="sd"> :type action: :class:`bool`</span> + +<span class="sd"> :param description: Help text for this script, handed down to</span> +<span class="sd"> |descattr|_ of |argpinit|_.</span> +<span class="sd"> :type description: :class:`str`</span> + +<span class="sd"> :returns: :class:`argparse.ArgumentParser`.</span> +<span class="sd"> """</span> + <span class="n">prog</span> <span class="o">=</span> <span class="bp">None</span> + <span class="k">if</span> <span class="n">action</span><span class="p">:</span> + <span class="n">prog</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">0</span><span class="p">])[</span><span class="mi">3</span><span class="p">:]</span> + <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prog</span><span class="o">=</span><span class="n">prog</span><span class="p">,</span> + <span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span> + <span class="n">formatter_class</span><span class="o">=</span>\ + <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentDefaultsHelpFormatter</span><span class="p">)</span> + <span class="bp">self</span><span class="o">.</span><span class="n">action</span> <span class="o">=</span> <span class="n">action</span> + +</div> +<div class="viewcode-block" id="PM3ArgumentParser.Parse"><a class="viewcode-back" href="../../../core/pm3argparse.html#promod3.core.pm3argparse.PM3ArgumentParser.Parse">[docs]</a> <span class="k">def</span> <span class="nf">Parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">namespace</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span> + <span class="sd">"""</span> +<span class="sd"> Parse an argument string.</span> + +<span class="sd"> :param args: The argument string. As default |sysargv|_ is used.</span> +<span class="sd"> :type args: :class:`list`</span> + +<span class="sd"> :param namespace: The same as for</span> +<span class="sd"> :meth:`argparse.ArgumentParser.parse_args`.</span> + +<span class="sd"> :returns: If :attr:`namespace` is not given,</span> +<span class="sd"> :class:`argparse.Namespace`.</span> +<span class="sd"> """</span> + <span class="n">opts</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">parse_args</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span> <span class="n">namespace</span><span class="o">=</span><span class="n">namespace</span><span class="p">)</span> + <span class="k">return</span> <span class="n">opts</span> + +<span class="c"># LocalWords: param attr prog argparse ArgumentParser bool sys os init str</span> +<span class="c"># LocalWords: progattr descattr argpinit argv formatter meth args namespace</span> +<span class="c"># LocalWords: ArgumentDefaultsHelpFormatter sysargv</span></div></div> +</pre></div> + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../../../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2015, Bienchen. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.3</a> + + </div> + + + + + </body> +</html> \ No newline at end of file diff --git a/doc/html/_sources/core/argcheck.txt b/doc/html/_sources/core/argcheck.txt index 53f517f1c77a98f14edaf19f8065563c194a8ed4..b9a35a624353e75b40ec545830da812d07b5aeff 100644 --- a/doc/html/_sources/core/argcheck.txt +++ b/doc/html/_sources/core/argcheck.txt @@ -9,8 +9,8 @@ Introduction For parsing command line arguments - :py_docs:`optional <howto/argparse.html#introducing-optional-arguments>` and :py_docs:`positional <howto/argparse.html#introducing-positional-arguments>` - -|project| tools should utilise Pythons own -:py_docs:`argparse <library/argparse.html>` module. While this comes with a lot +|project| tools should utilise its own +:mod:`~promod3.core.pm3argparse` module. While this comes with a lot of functionality to fetch values from the command line comfortably, it has no means in checking/ verifying input. Some of the most common tests are covered here. All tests are designed to exit a script on failure. @@ -63,4 +63,6 @@ File Tests .. autofunction:: FileExtension -.. LocalWords: currentmodule py howto argparse +.. LocalWords: currentmodule py howto argparse testcode argcheck os promod +.. LocalWords: tempfile fh fn ArgumentParser str args FileExists gz pdb +.. LocalWords: FileExtension mmcif doctest autofunction diff --git a/doc/html/_sources/core/index.txt b/doc/html/_sources/core/index.txt index 1e2eccafc89bbb443c29d0b55bf9fc0eeec8aaac..8adefa269ed7f4f9bcdfdceff447a23649ccee35 100644 --- a/doc/html/_sources/core/index.txt +++ b/doc/html/_sources/core/index.txt @@ -9,7 +9,9 @@ modeling per se but cover standard programming issues. .. toctree:: :maxdepth: 2 - + + pm3argparse + argcheck helper diff --git a/doc/html/_sources/core/pm3argparse.txt b/doc/html/_sources/core/pm3argparse.txt new file mode 100644 index 0000000000000000000000000000000000000000..43e05c1265ae13d3092c52a3c8e30bfdde516afc --- /dev/null +++ b/doc/html/_sources/core/pm3argparse.txt @@ -0,0 +1,36 @@ +:mod:`~promod3.core.pm3argparse` - Parsing Command Lines +================================================================================ + +.. currentmodule:: promod3.core.pm3argparse + +.. module:: promod3.core.pm3argparse + +Introduction +-------------------------------------------------------------------------------- + +A lot of the actions in |project| have a bunch of command line parameters/ +arguments in common. For example we need an input alignment quite often and +usually for an alignment we need information on what is the target sequence, +what identifies a template sequence and eventually a hint on the format. That +means we need the same functionality on the command line in several actions. +There :class:`pm3argparse.PM3ArgumentParser` serves as a simplification. It +provides a set of standard arguments you just need to activate for your action +plus it comes with some verification functionality for input. + +.. synopsis/ example + +Argument Parser +-------------------------------------------------------------------------------- + +.. autoclass:: PM3ArgumentParser + :members: + + .. automethod:: __init__ + +.. |descattr| replace:: :attr:`description` +.. |argpinit| replace:: :meth:`argparse.ArgumentParser.__init__` +.. |progattr| replace:: :attr:`prog` +.. |sysargv| replace:: :attr:`sys.argv` + +.. LocalWords: currentmodule argparse ArgumentParser autoclass automethod +.. LocalWords: init descattr attr argpinit meth progattr prog diff --git a/doc/html/core/argcheck.html b/doc/html/core/argcheck.html index a5b0ab7106ce0c4c7b11553596ca291b227069f7..3ecd6b1b1e52dae0a4e6b3e13d4b7137e18f6f57 100644 --- a/doc/html/core/argcheck.html +++ b/doc/html/core/argcheck.html @@ -26,7 +26,7 @@ <link rel="top" title="ProMod3 0 documentation" href="../index.html" /> <link rel="up" title="core - ProMod3 Core Functionality" href="index.html" /> <link rel="next" title="helper - Shared Functionality For the Everything" href="helper.html" /> - <link rel="prev" title="core - ProMod3 Core Functionality" href="index.html" /> + <link rel="prev" title="pm3argparse - Parsing Command Lines" href="pm3argparse.html" /> <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> @@ -46,7 +46,7 @@ <a href="helper.html" title="helper - Shared Functionality For the Everything" accesskey="N">next</a> |</li> <li class="right" > - <a href="index.html" title="core - ProMod3 Core Functionality" + <a href="pm3argparse.html" title="pm3argparse - Parsing Command Lines" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="../index.html">ProMod3 0 documentation</a> »</li> <li class="nav-item nav-item-1"><a href="../developers.html" >Documentation For Developes</a> »</li> @@ -66,8 +66,8 @@ <p>For parsing command line arguments - <a class="reference external" href="https://docs.python.org/2.7/howto/argparse.html#introducing-optional-arguments">optional</a> and <a class="reference external" href="https://docs.python.org/2.7/howto/argparse.html#introducing-positional-arguments">positional</a> - -ProMod3 tools should utilise Pythons own -<a class="reference external" href="https://docs.python.org/2.7/library/argparse.html">argparse</a> module. While this comes with a lot +ProMod3 tools should utilise its own +<a class="reference internal" href="pm3argparse.html#module-promod3.core.pm3argparse" title="promod3.core.pm3argparse"><code class="xref py py-mod docutils literal"><span class="pre">pm3argparse</span></code></a> module. While this comes with a lot of functionality to fetch values from the command line comfortably, it has no means in checking/ verifying input. Some of the most common tests are covered here. All tests are designed to exit a script on failure.</p> @@ -172,8 +172,8 @@ shell. <code class="docutils literal"><span class="pre">0</span></code> is tradi </ul> <h4>Previous topic</h4> - <p class="topless"><a href="index.html" - title="previous chapter"><code class="docutils literal"><span class="pre">core</span></code> - ProMod3 Core Functionality</a></p> + <p class="topless"><a href="pm3argparse.html" + title="previous chapter"><code class="docutils literal"><span class="pre">pm3argparse</span></code> - Parsing Command Lines</a></p> <h4>Next topic</h4> <p class="topless"><a href="helper.html" title="next chapter"><code class="docutils literal"><span class="pre">helper</span></code> - Shared Functionality For the Everything</a></p> diff --git a/doc/html/core/index.html b/doc/html/core/index.html index c286a628d66b4d3c324bbf7f7a8a5ba09b394b78..aca0f41d3cbdfdbf61f6a452a6985720e437ee95 100644 --- a/doc/html/core/index.html +++ b/doc/html/core/index.html @@ -25,7 +25,7 @@ <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="top" title="ProMod3 0 documentation" href="../index.html" /> <link rel="up" title="Documentation For Developes" href="../developers.html" /> - <link rel="next" title="argcheck - Standard Tests For Command Line Arguments" href="argcheck.html" /> + <link rel="next" title="pm3argparse - Parsing Command Lines" href="pm3argparse.html" /> <link rel="prev" title="SetCompoundsChemlib()" href="setcompoundschemlib.html" /> @@ -43,7 +43,7 @@ <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > - <a href="argcheck.html" title="argcheck - Standard Tests For Command Line Arguments" + <a href="pm3argparse.html" title="pm3argparse - Parsing Command Lines" accesskey="N">next</a> |</li> <li class="right" > <a href="setcompoundschemlib.html" title="SetCompoundsChemlib()" @@ -64,6 +64,11 @@ modeling per se but cover standard programming issues.</p> <div class="toctree-wrapper compound"> <ul> +<li class="toctree-l1"><a class="reference internal" href="pm3argparse.html"><code class="docutils literal"><span class="pre">pm3argparse</span></code> - Parsing Command Lines</a><ul> +<li class="toctree-l2"><a class="reference internal" href="pm3argparse.html#introduction">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="pm3argparse.html#argument-parser">Argument Parser</a></li> +</ul> +</li> <li class="toctree-l1"><a class="reference internal" href="argcheck.html"><code class="docutils literal"><span class="pre">argcheck</span></code> - Standard Tests For Command Line Arguments</a><ul> <li class="toctree-l2"><a class="reference internal" href="argcheck.html#introduction">Introduction</a></li> <li class="toctree-l2"><a class="reference internal" href="argcheck.html#file-tests">File Tests</a></li> @@ -88,8 +93,8 @@ modeling per se but cover standard programming issues.</p> <p class="topless"><a href="setcompoundschemlib.html" title="previous chapter"><code class="docutils literal"><span class="pre">SetCompoundsChemlib()</span></code></a></p> <h4>Next topic</h4> - <p class="topless"><a href="argcheck.html" - title="next chapter"><code class="docutils literal"><span class="pre">argcheck</span></code> - Standard Tests For Command Line Arguments</a></p> + <p class="topless"><a href="pm3argparse.html" + title="next chapter"><code class="docutils literal"><span class="pre">pm3argparse</span></code> - Parsing Command Lines</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> diff --git a/doc/html/core/pm3argparse.html b/doc/html/core/pm3argparse.html new file mode 100644 index 0000000000000000000000000000000000000000..c43e12fe229e829e792993fd25fb2eead929df31 --- /dev/null +++ b/doc/html/core/pm3argparse.html @@ -0,0 +1,221 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>pm3argparse - Parsing Command Lines — ProMod3 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"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '0', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </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> + <link rel="top" title="ProMod3 0 documentation" href="../index.html" /> + <link rel="up" title="core - ProMod3 Core Functionality" href="index.html" /> + <link rel="next" title="argcheck - Standard Tests For Command Line Arguments" href="argcheck.html" /> + <link rel="prev" title="core - ProMod3 Core Functionality" href="index.html" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9"> + + </head> + <body role="document"> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="../py-modindex.html" title="Python Module Index" + >modules</a> |</li> + <li class="right" > + <a href="argcheck.html" title="argcheck - Standard Tests For Command Line Arguments" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="index.html" title="core - ProMod3 Core Functionality" + accesskey="P">previous</a> |</li> + <li class="nav-item nav-item-0"><a href="../index.html">ProMod3 0 documentation</a> »</li> + <li class="nav-item nav-item-1"><a href="../developers.html" >Documentation For Developes</a> »</li> + <li class="nav-item nav-item-2"><a href="index.html" accesskey="U"><code class="docutils literal"><span class="pre">core</span></code> - ProMod3 Core Functionality</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="module-promod3.core.pm3argparse"> +<span id="pm3argparse-parsing-command-lines"></span><h1><a class="reference internal" href="#module-promod3.core.pm3argparse" title="promod3.core.pm3argparse"><code class="xref py py-mod docutils literal"><span class="pre">pm3argparse</span></code></a> - Parsing Command Lines<a class="headerlink" href="#module-promod3.core.pm3argparse" title="Permalink to this headline">¶</a></h1> +<div class="section" id="introduction"> +<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2> +<p>A lot of the actions in ProMod3 have a bunch of command line parameters/ +arguments in common. For example we need an input alignment quite often and +usually for an alignment we need information on what is the target sequence, +what identifies a template sequence and eventually a hint on the format. That +means we need the same functionality on the command line in several actions. +There <code class="xref py py-class docutils literal"><span class="pre">pm3argparse.PM3ArgumentParser</span></code> serves as a simplification. It +provides a set of standard arguments you just need to activate for your action +plus it comes with some verification functionality for input.</p> +</div> +<div class="section" id="argument-parser"> +<h2>Argument Parser<a class="headerlink" href="#argument-parser" title="Permalink to this headline">¶</a></h2> +<dl class="class"> +<dt id="promod3.core.pm3argparse.PM3ArgumentParser"> +<em class="property">class </em><code class="descclassname">promod3.core.pm3argparse.</code><code class="descname">PM3ArgumentParser</code><span class="sig-paren">(</span><em>action=True</em>, <em>description=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/promod3/core/pm3argparse.html#PM3ArgumentParser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#promod3.core.pm3argparse.PM3ArgumentParser" title="Permalink to this definition">¶</a></dt> +<dd><p>This class is a child of <a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.ArgumentParser" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">argparse.ArgumentParser</span></code></a>. It provides a +set of standard arguments which can be activated, rather than added via the +traditional way. This helps keeping up a common naming scheme throughout +all ProMod3 actions. As a real extension, this subclass provides checking +of input parameters on <code class="xref py py-meth docutils literal"><span class="pre">Parse()</span></code>. Beside +this, everything you can do with a ‘real’ <a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.ArgumentParser" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">ArgumentParser</span></code></a> +instance is possible here.</p> +<p>A note on exit codes: if <code class="xref py py-meth docutils literal"><span class="pre">Parse()</span></code> is +called on unrecognised arguments, the script exits with a code 2 by +<code class="xref py py-class docutils literal"><span class="pre">argparse.ArgumentParser.parse_args()</span></code>.</p> +<p>Attributes beyond <a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.ArgumentParser" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">argparse.ArgumentParser</span></code></a>:</p> +<dl class="attribute"> +<dt id="promod3.core.pm3argparse.PM3ArgumentParser.action"> +<code class="descname">action</code><a class="headerlink" href="#promod3.core.pm3argparse.PM3ArgumentParser.action" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<p>Indicates if the calling script is a ProMod3 action.</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">Type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2.7/library/functions.html#bool" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">bool</span></code></a></td> +</tr> +</tbody> +</table> +<dl class="method"> +<dt id="promod3.core.pm3argparse.PM3ArgumentParser.__init__"> +<code class="descname">__init__</code><span class="sig-paren">(</span><em>action=True</em>, <em>description=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/promod3/core/pm3argparse.html#PM3ArgumentParser.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#promod3.core.pm3argparse.PM3ArgumentParser.__init__" title="Permalink to this definition">¶</a></dt> +<dd><p>Create a new instance of <code class="xref py py-class docutils literal"><span class="pre">PM3ArgumentParser</span></code>.</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>action</strong> (<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#bool" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">bool</span></code></a>) – Indicates if the calling script is a ProMod3 action. +This influences <a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#prog"><code class="xref py py-attr docutils literal"><span class="pre">prog</span></code></a> of +<a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.ArgumentParser" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">ArgumentParser</span></code></a> by clipping of the +first 3 characters of the file name of the script. If +<code class="docutils literal"><span class="pre">False</span></code>, default behaviour of +<a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.ArgumentParser" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">ArgumentParser</span></code></a> kicks in.</li> +<li><strong>description</strong> (<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#str" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">str</span></code></a>) – Help text for this script, handed down to +<a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#description"><code class="xref py py-attr docutils literal"><span class="pre">description</span></code></a> of <a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.ArgumentParser"><code class="xref py py-meth docutils literal"><span class="pre">argparse.ArgumentParser.__init__()</span></code></a>.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.ArgumentParser" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">argparse.ArgumentParser</span></code></a>.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +<dl class="method"> +<dt id="promod3.core.pm3argparse.PM3ArgumentParser.Parse"> +<code class="descname">Parse</code><span class="sig-paren">(</span><em>args=None</em>, <em>namespace=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/promod3/core/pm3argparse.html#PM3ArgumentParser.Parse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#promod3.core.pm3argparse.PM3ArgumentParser.Parse" title="Permalink to this definition">¶</a></dt> +<dd><p>Parse an argument 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"><ul class="first simple"> +<li><strong>args</strong> (<a class="reference external" href="https://docs.python.org/2.7/library/functions.html#list" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">list</span></code></a>) – The argument string. As default <a class="reference external" href="https://docs.python.org/2.7/library/sys.html#sys.argv"><code class="xref py py-attr docutils literal"><span class="pre">sys.argv</span></code></a> is used.</li> +<li><strong>namespace</strong> – The same as for +<a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.ArgumentParser.parse_args" title="(in Python v2.7)"><code class="xref py py-meth docutils literal"><span class="pre">argparse.ArgumentParser.parse_args()</span></code></a>.</li> +</ul> +</td> +</tr> +<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">If <code class="xref py py-attr docutils literal"><span class="pre">namespace</span></code> is not given, +<a class="reference external" href="https://docs.python.org/2.7/library/argparse.html#argparse.Namespace" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">argparse.Namespace</span></code></a>.</p> +</td> +</tr> +</tbody> +</table> +</dd></dl> + +</dd></dl> + +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#"><code class="docutils literal"><span class="pre">pm3argparse</span></code> - Parsing Command Lines</a><ul> +<li><a class="reference internal" href="#introduction">Introduction</a></li> +<li><a class="reference internal" href="#argument-parser">Argument Parser</a></li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="index.html" + title="previous chapter"><code class="docutils literal"><span class="pre">core</span></code> - ProMod3 Core Functionality</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="argcheck.html" + title="next chapter"><code class="docutils literal"><span class="pre">argcheck</span></code> - Standard Tests For Command Line Arguments</a></p> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../_sources/core/pm3argparse.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms or a module, class or function name. + </p> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2015, Bienchen. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.3</a> + + | + <a href="../_sources/core/pm3argparse.txt" + rel="nofollow">Page source</a></li> + </div> + + + + + </body> +</html> \ No newline at end of file diff --git a/doc/html/developers.html b/doc/html/developers.html index b172eed0815a11fea304f50075d46d14e121190f..fe4c5efbec7cdf2a34bd07fc640fe432178e584f 100644 --- a/doc/html/developers.html +++ b/doc/html/developers.html @@ -63,6 +63,7 @@ <ul> <li class="toctree-l1"><a class="reference internal" href="core/setcompoundschemlib.html"><code class="docutils literal"><span class="pre">SetCompoundsChemlib()</span></code></a></li> <li class="toctree-l1"><a class="reference internal" href="core/index.html"><code class="docutils literal"><span class="pre">core</span></code> - ProMod3 Core Functionality</a><ul> +<li class="toctree-l2"><a class="reference internal" href="core/pm3argparse.html"><code class="docutils literal"><span class="pre">pm3argparse</span></code> - Parsing Command Lines</a></li> <li class="toctree-l2"><a class="reference internal" href="core/argcheck.html"><code class="docutils literal"><span class="pre">argcheck</span></code> - Standard Tests For Command Line Arguments</a></li> <li class="toctree-l2"><a class="reference internal" href="core/helper.html"><code class="docutils literal"><span class="pre">helper</span></code> - Shared Functionality For the Everything</a></li> </ul> diff --git a/doc/html/genindex.html b/doc/html/genindex.html index 3fe5beb1229c560246f23eff384d307fbf4b881f..b5a5942ca6c433cc2546836200be857d89e42736 100644 --- a/doc/html/genindex.html +++ b/doc/html/genindex.html @@ -53,7 +53,8 @@ <h1 id="index">Index</h1> <div class="genindex-jumpbox"> - <a href="#A"><strong>A</strong></a> + <a href="#_"><strong>_</strong></a> + | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#F"><strong>F</strong></a> @@ -65,13 +66,29 @@ | <a href="#T"><strong>T</strong></a> </div> +<h2 id="_">_</h2> +<table style="width: 100%" class="indextable genindextable"><tr> + <td style="width: 33%" valign="top"><dl> + + <dt><a href="core/pm3argparse.html#promod3.core.pm3argparse.PM3ArgumentParser.__init__">__init__() (promod3.core.pm3argparse.PM3ArgumentParser method)</a> + </dt> + + </dl></td> +</tr></table> + <h2 id="A">A</h2> <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%" valign="top"><dl> + <dt><a href="core/pm3argparse.html#promod3.core.pm3argparse.PM3ArgumentParser.action">action (promod3.core.pm3argparse.PM3ArgumentParser attribute)</a> + </dt> + + <dt><a href="actions/index_dev.html#test_actions.ActionTestCase">ActionTestCase (class in test_actions)</a> </dt> + </dl></td> + <td style="width: 33%" valign="top"><dl> <dt> add_doc_dependency @@ -83,8 +100,6 @@ </dt> </dl></dd> - </dl></td> - <td style="width: 33%" valign="top"><dl> <dt> add_doc_source @@ -208,6 +223,14 @@ <table style="width: 100%" class="indextable genindextable"><tr> <td style="width: 33%" valign="top"><dl> + <dt><a href="core/pm3argparse.html#promod3.core.pm3argparse.PM3ArgumentParser.Parse">Parse() (promod3.core.pm3argparse.PM3ArgumentParser method)</a> + </dt> + + + <dt><a href="core/pm3argparse.html#promod3.core.pm3argparse.PM3ArgumentParser">PM3ArgumentParser (class in promod3.core.pm3argparse)</a> + </dt> + + <dt> pm_action </dt> @@ -233,6 +256,10 @@ </dt> + <dt><a href="core/pm3argparse.html#module-promod3.core.pm3argparse">promod3.core.pm3argparse (module)</a> + </dt> + + <dt><a href="rawmodel/index.html#module-promod3.rawmodel">promod3.rawmodel (module)</a> </dt> diff --git a/doc/html/objects.inv b/doc/html/objects.inv index 5fc261bdba7c88113188adb3ca36f70469986752..766bd3e3e580e3cae68902a296510d9251ec0bd4 100644 Binary files a/doc/html/objects.inv and b/doc/html/objects.inv differ diff --git a/doc/html/py-modindex.html b/doc/html/py-modindex.html index 9f7275fe258a31219d39c054148fdf86dc007e77..f26f8cbf378161ed28c95d408117245fe4973c9b 100644 --- a/doc/html/py-modindex.html +++ b/doc/html/py-modindex.html @@ -74,6 +74,11 @@ <td> <a href="core/index.html#module-promod3.core"><code class="xref">promod3.core</code></a></td><td> <em>Basic functionality, supporting standard tasks in your code.</em></td></tr> + <tr class="cg-1"> + <td></td> + <td> + <a href="core/pm3argparse.html#module-promod3.core.pm3argparse"><code class="xref">promod3.core.pm3argparse</code></a></td><td> + <em></em></td></tr> <tr class="cg-1"> <td></td> <td> diff --git a/doc/html/searchindex.js b/doc/html/searchindex.js index b71719d81e45569c05c8d9f5b6957d25f9260540..739678d5d1743f1569e8b2fe0000c7b562ef7407 100644 --- a/doc/html/searchindex.js +++ b/doc/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:46,filenames:["actions/index_dev","buildsystem","changelog","cmake/index","contributing","core/argcheck","core/helper","core/index","core/setcompoundschemlib","developers","index","rawmodel/index","users"],objects:{"":{"command:add_doc_dependency":[3,0,1,""],"command:add_doc_source":[3,0,1,""],"command:pm_action":[3,0,1,""],"command:promod3_unittest":[3,0,1,""],test_actions:[0,1,0,"-"]},"promod3.core.argcheck":{FileExists:[5,2,1,""],FileExtension:[5,2,1,""]},"promod3.core.helper":{MsgErrorAndExit:[6,2,1,""]},"promod3.rawmodel":{BuildRawModel:[11,2,1,""],RawModelingResult:[11,4,1,""]},"promod3.rawmodel.RawModelingResult":{gaps:[11,3,1,""],model:[11,3,1,""]},"test_actions.ActionTestCase":{RunAction:[0,5,1,""],RunExitStatusTest:[0,5,1,""],pm_action:[0,3,1,""],pm_bin:[0,3,1,""],testPMExists:[0,5,1,""]},promod3:{SetCompoundsChemlib:[8,2,1,""],core:[7,1,0,"-"],rawmodel:[11,1,0,"-"]},test_actions:{ActionTestCase:[0,4,1,""]}},objnames:{"0":["cmake","command","CMake command"],"1":["py","module","Python module"],"2":["py","function","Python function"],"3":["py","attribute","Python attribute"],"4":["py","class","Python class"],"5":["py","method","Python method"]},objtypes:{"0":"cmake:command","1":"py:module","2":"py:function","3":"py:attribute","4":"py:class","5":"py:method"},terms:{"2b1":1,"__init__":[0,4],"__main__":[0,4],"__name__":[0,4],"_opt":4,"_run":[0,3],"_xml":3,"boolean":5,"break":[3,4],"case":4,"class":[0,4,7,11],"default":[0,1,4,8],"final":[4,11],"import":[],"int":[0,5,6],"new":[0,4,11],"public":4,"return":[0,5,6,8,11],"short":4,"static":4,"switch":4,"throw":0,"true":[0,4,5,11],"try":[0,4],"var":[],"while":[0,3,4,5],abil:4,abort:4,about:[0,3,4,11],abov:[0,4],absolut:3,academ:4,accord:4,achiev:4,acid:11,acknowledg:4,across:0,action_rst:[],action_unit_test:0,actiontest:0,activ:4,actual:4,add:[0,3,4],add_argu:5,add_changelog_to_doc:4,add_custom_target:4,add_doc_depend:3,add_doc_sourc:[3,4],add_subdirectori:4,addit:[3,4,5],addition:[0,3],additional_make_clean_fil:4,admir:4,advic:4,advis:4,affect:4,after:[0,1,4],again:[1,4],ago:0,algorithm:[4,11],alias:4,align:11,all:[0,1,3,4,5,11],allow:4,almost:3,aln:11,alon:6,along:[0,4],alot:4,alreadi:[0,3,4],also:[0,1,3,4,5,11],alwai:[0,4],amino:11,ancient:8,ani:[0,3,4,8],announc:[0,4],anyth:[1,4,8],anywai:4,apart:0,api:[],appli:[4,8],applic:0,approach:4,arg:[0,4],argpars:5,argument:[],argumentpars:5,around:[0,4],ask:4,assertequ:4,assum:[0,4],atom:11,attach:[3,11],attachview:11,attent:[0,4],attr:[],attribut:4,author:4,autom:3,automat:[0,4,5],automatis:4,avail:[0,1,4,8],avoid:[4,8],awai:4,awar:4,awesom:[0,4],awesomeactiontest:4,back:[0,4],backbon:11,background:1,bar:[],base:[5,11],basi:[3,4],basic:[0,1,4,11],becaus:[1,4],been:4,befor:[0,3,4],begin:[0,4],behav:0,behind:4,bell:4,belong:[3,4],below:4,besid:[1,3],best:3,between:0,bienchen:4,bin:[],binari:[0,4],bit:[0,1,4],bla:[],blank:4,block:[],bool:[0,5],boost:[0,1,2,3,4,5,6,7,8,9,10,11,12],boost_include_dir:4,boost_root:1,branchnam:4,brew:3,briefli:4,bring:4,broken:0,bug:4,builder:1,buildrawmodel:11,built:[3,4],bunch:[0,4],bytecod:0,cach:[1,4],call:[0,1,3,4,8],calpha:11,calpha_onli:11,came:4,can:[0,1,4,5,8,11],cannot:4,captur:0,carri:[4,5],categori:3,caus:4,certain:[0,1,3,4],certainli:0,chain:[4,11],chanc:4,chapter:4,charg:4,check:[0,1,4,5],checkout:4,chemic:8,childclass:0,chmod:4,clean:[1,4],clone:4,close:4,clutter:[0,4],cmake_build_typ:4,cmake_c_compiler_vers:4,cmake_compiler_is_gnucxx:4,cmake_current_source_dir:4,cmake_cxx_compiler_vers:4,cmake_cxx_flag:4,cmake_cxx_flags_releas:4,cmake_minimum_requir:4,cmake_module_path:4,cmake_source_dir:4,cmake_support:[3,4],cmakecach:1,cmakelist:[0,1,3,4],coars:4,code:[0,1,3,4,5,6,8],codetest:[3,4],collect:6,come:[0,3,4,5],comfort:5,command:[],comment:4,commerci:4,commit:4,common:[4,5],compat:4,compil:[0,4],complain:0,complaint:4,complet:[4,11],complex:4,compon:[4,8],compound:8,compress:5,concept:4,condit:4,conf:[1,4],config:4,configur:[1,4],conflict:4,connect:[3,4],conop:4,conquer:4,consid:[3,4],consist:4,contain:[0,1,3,4,5,11],content:[4,9,10],continu:0,contribut:[],control:4,conveni:0,convent:0,convert:11,coordin:[],cope:4,copi:[3,4,11],core:[],correspond:4,could:[0,3,4,11],coupl:[0,4],cours:4,cover:[0,4,5,7],creat:[],croak:4,crucial:4,current:4,custom:4,cxx:4,dai:5,dare:3,data1:3,data2:3,data:[0,3,4],date:4,dbg:4,debug:4,decent:8,decid:4,declar:[3,4],dedic:[1,3,4],def:[0,4],defin:[0,3,8],definit:4,delet:11,deliv:0,dep:3,dependency1:3,dependency2:3,deriv:0,dervi:[],describ:[3,5],descript:4,design:[0,5],detail:[4,11],detect:5,determin:5,deuterium:11,develop:[],devot:7,dictionari:8,did:4,differ:[0,1,3,4,8],dir:4,direct:4,directori:[],dirti:0,disabl:[0,4],disable_disable_doctest:4,disable_disable_linkcheck:4,disable_doctest:[1,4],disable_document:[1,4],disable_linkcheck:[1,4],displai:5,distribut:[0,4],dive:4,diverg:4,doawesomeactiontest:0,doc:[1,3,4],doctest:[1,4],document:[],doe:[0,3,4,5,8,11],don:[1,4],done:[0,4],dont_write_bytecod:[0,4],doptim:4,dost_root:[1,4],download:1,dqmean_root:[1,4],drawback:4,driven:4,drop:4,due:11,dure:0,each:[],easi:4,easier:[0,4],easili:[3,4],echo:4,editor:0,educ:4,effect:[3,4],eigen3:4,eigen3_found:4,eigen3_include_dir:[1,4],eigen:[1,4],eigenvalu:4,eigenvector:4,either:[4,11],elabor:4,element:0,els:4,emerg:0,emploi:4,empti:[4,6],enabl:[0,5,8],end:[0,1,3,4,5,6],endif:4,enough:4,entiti:4,entityhandl:11,entri:4,enumer:4,env:4,environ:[0,4],error:[5,6],essenti:4,etc:[0,4],evalu:[3,4],even:[1,4],ever:4,everi:[0,4,11],everybodi:4,everyth:[],exactli:1,exampl:[0,1,4,11],except:4,exclud:4,exclus:[0,4],exec_program:4,execut:[],executable_output_path:4,exist:[0,3,4,5],exit:[0,5,6],exit_cod:0,exit_statu:[5,6],exot:4,expand:4,expect:0,explain:4,explan:4,ext:5,extend:[0,3,4],extens:5,extern:[3,4],extra:4,extract:4,fail:[0,4,6],failur:[4,5],fals:[0,4,5,11],fasta:11,fatal_error:4,favourit:0,featur:4,fed:[3,4],fedora:4,feed:3,feel:4,fellow:4,fetch:[4,5],few:[1,4,11],figur:4,file:[],filecheck:4,fileexist:5,fileextens:5,filenam:4,files_to_be_remov:4,fill:[3,4],find:[3,4],find_packag:4,fine:4,fire:0,first:[0,2,4],fix:[4,5],flag1:3,flag2:3,flag:[3,4,5],flush:[0,4],fno:4,folder:4,follow:[0,4,11],foo:[],forbidden:4,forg:4,forget:[0,1,4],format:4,formatt:4,forward:4,found:[0,3,4],foundat:0,frame:4,framework:4,free:4,from:[0,1,2,3,4,5,6,11],front:[0,1,4,5],full:[0,4],fulli:4,functions_specific_to_your_act:4,funni:[1,4],gap:11,gather:[3,4,7],gcc:4,gener:[0,4],generalis:4,get:[0,1,4],git:[],gitignor:4,give:[3,4],given:[0,3,5],global:8,gly:11,goal:0,goe:[1,4],good:[3,4],got:1,grain:4,grep:1,grow:11,gui:4,gzip:5,hand:[1,3],handl:11,happen:[0,4],have:[],headach:4,header:[1,4],header_stage_path:4,headlin:4,help:[],helpactiontest:[],helper:[],henc:4,here:[0,1,3,4,5,6,11],hide:4,hierarchi:8,higher:1,highest:8,highli:1,histori:4,hit:[0,4],hold:11,home:[],homolog:7,honour:11,host:[3,4],hotfix:4,hous:4,html:[1,2,4],http:4,hydrogen:11,hyphen:0,idea:[0,2,4],ignor:11,imagin:4,imaginari:0,immedi:[0,4,8],implement:4,implicit:1,includ:[2,4,5],include_directori:4,incomplet:11,inconveni:4,incred:11,index:[4,10],indic:[],info:[],inform:[4,11],inherit:0,init:4,initi:2,initialis:0,inlin:4,inport:[],input:[0,5],insert:11,insid:[0,3],insight:4,instal:[1,4],instead:[0,1,3,4,5],integr:[],intend:[0,4],interest:0,interfac:4,intermedi:4,intern:[0,3,4],internet:4,interpret:[4,6],intervent:4,introduc:[0,3,4],invok:[1,3,4,8],involv:4,item:[0,4,11],itself:[3,4],job:4,just:[0,1,4,8],keep:[0,3,4],kic:4,kind:[0,4],know:1,known:[3,5],kwarg:[0,4],label:4,languag:3,lapack:[1,4],last:[0,3],later:[0,4],latest:1,latter:4,launcher:[3,4],lead:[4,5],least:[1,3,4],leav:0,left:6,legal:4,less:4,let:[0,4],level:[1,4,8],lib_stage_path:4,libexec:[3,4],libexec_stage_path:4,librari:[3,4,8],library1:3,library2:3,life:4,like:[0,1,3,4,11],line:[],lineno:[],link:[1,3,4],linkcheck:[1,4],linker:3,list:[0,1,3,4,5,11],littl:[3,4],live:[3,4],load:[0,8],loadalign:11,loadpdb:11,locat:[1,3],log:[4,6],look:[4,5],loop:[4,11],loss:4,lost:[0,4],lot:[0,4,5],low:0,macro:[3,4],made:3,magic:4,mai:[0,1,3,4,11],main:[],mainattr:[],maintain:4,major:4,make_directori:4,makefil:[1,4],malici:4,man:[1,4],manag:[3,4],mandatori:4,mani:6,manner:4,manual:[0,1,4],markup:4,master:4,match:[3,4,11],materi:[0,4],matter:3,mean:[1,3,4,5],meld:2,member:[4,11],mention:0,merg:4,mess:4,messag:[],messi:4,methionin:11,method:0,middl:4,mind:[0,4],minimalist:11,miss:[5,11],mix:3,mkdir:4,mmcif:5,mod:4,mode:0,model:[],modif:11,modifi:[2,4,11],modul:[],mol:4,mol_alg:4,moment:4,monitor:0,monolith:4,mood:4,more:[0,1,3,4,11],most:[3,4,5,11],mostli:[3,4],move:4,msg:6,msgerrorandexit:6,much:[4,11],multipl:4,must:[],name:[0,3,4,5],need:[0,1,3,4,5,8],neg:0,never:4,nevertheless:4,next:[0,4],nice:4,nobodi:0,non:4,note:4,noth:[3,4],notic:[0,3,4],now:[0,4,11],number:[0,11],obtain:11,obviou:4,off:[0,4,11],often:[4,5],onc:[0,4],onli:[0,3,4,5,8,11],onto:0,openstructur:[0,1,2,3,4,5,6,7,8,9,10,11,12],oper:4,opt:[4,5],optim:[1,4],optimis:4,option:[1,4,5],org:4,origin:4,ost:[0,1,2,3,4,5,6,7,8,9,10,11,12],ost_doc_url:4,ost_double_precis:1,ost_include_dir:4,ost_root:[1,4],other:[0,1,4,11],otherwis:[0,3,4],ouput:[],our:[3,4],out:[0,1,3,4],output:[],output_vari:4,outsid:4,over:[1,3,4,11],overli:4,overview:4,own:[],packag:[3,4],page:[1,4,10],pai:0,paragraph:[0,4],param:[],paramet:[0,3,5,6,8,11],parent:11,pars:5,parse_arg:5,part:[0,4],particular:4,pass:4,past:4,path:[0,1,3,4,5],path_to_chemlib:8,pdb:[5,11],peopl:4,pep:[0,1,2,3,4,5,6,7,8,9,10,11,12],peptid:11,per:[3,4,7],perfect:4,perfectli:4,perform:4,permiss:4,phosphoserin:11,phrase:4,pictur:4,piec:4,place:[0,4,6],pleas:4,plu:[4,8],pm3_csc:4,pm_action:[0,3,4],pm_action_init:4,pm_bin:0,point:[1,4,8],pointer:1,pop:4,popul:[1,4],posit:5,possibl:[4,11],practic:[3,4],pre:4,pre_commit:4,prefer:3,prefix:[0,3,4,5],prepar:4,prevent:[0,4],print:[0,1],privat:0,probabl:[1,3,4],problem:4,process:[0,4],produc:[0,1,3,4],product:[0,4],program:[3,4,7],project:[3,4],project_binary_dir:4,project_nam:4,promod3_unittest:[0,3,4],promod3_version_major:4,promod3_version_minor:4,promod3_version_patch:4,promod3_version_str:4,promod_gcc_45:4,promot:4,propag:4,proper:4,properli:0,properti:4,protein:11,provid:[0,1,3,4],pseudo:11,pull:[1,4],punch:0,purpos:4,push:4,put:[0,1,3,4,5],py_run:[0,3,4],pyc:[0,4],pylint:4,pylintrc:4,pymod:4,python:[0,1,2,3,4,5,6,7,8,9,10,11,12],python_binari:4,python_doc_url:4,python_root:1,python_vers:4,qmean:[1,4],qmean_include_dir:4,qmean_root:[1,4],quickli:4,quit:4,rais:11,rare:4,rather:[4,6],raw:[],rawmodel:[],rawmodelingresult:11,read:4,readabl:4,reader:4,readi:1,real:4,realli:[0,1,4,5],reappear:4,reason:4,rebas:4,rebuild:[1,4],recent:4,recognis:[0,4],recommend:1,record:0,refer:[0,3],regist:[3,4],rel:3,relat:[3,4],relev:[1,3],rememb:0,remov:1,renam:2,renumb:11,report:[0,4,11],repositori:[0,2,3,4],requir:[1,4],resembl:4,reserv:[5,6],residu:11,resolv:4,respons:4,rest:[0,1,2,3,4,5,6,7,8,9,10,11,12],restrict:4,restrict_chain:11,restructuredtext:[0,1,2,3,4,5,6,7,8,9,10,11,12],result:[1,4,11],reus:11,review:4,reviv:4,rewrit:0,right:[0,1,4],root:[3,4],routin:0,rst1:3,rst2:3,rst:[3,4],rule:4,runact:0,runexitstatustest:[0,4],runnabl:4,runtest:[0,4],runtimeerror:11,same:[0,1,3,4],sampl:[],save:4,savepdb:11,scenario:[],scheme:[0,4],script:[],seamlessli:4,search:[1,4,10],second:11,secondli:4,section:[0,3],see:[0,4],seem:4,select:11,selenium:11,self:[0,4],send:6,separ:[0,4],seq:[4,11],seq_alg:4,sequenc:11,serv:0,servic:4,set:[0,1,3,4,5,8,11],set_directory_properti:4,setup:[2,4],setup_boost:4,setup_compiler_flag:4,setup_stag:4,sever:[1,4],shebang:4,shell:[0,1,4,5,6],should:[],show:[0,4],shown:4,side:[4,11],sidechain:4,sidechains_pymod:4,sidechains_rst:4,sidechains_unit_test:4,silent:0,similar:[0,1,4],simplest:4,sinc:[0,1,3,4,5],singl:[3,4,11],sit:4,skip:[0,4],smallish:[1,4],smart:4,smng:2,softwar:4,sole:[0,4],solut:4,solv:4,solver:4,some:[0,1,3,4,5],somebodi:[],someth:[0,4,6],somethingtest:4,sometim:4,somewher:3,soon:4,sort:[0,3],sound:4,sourc:[0,1,3,4,5,6,8],source1:[3,4],source2:[3,4],spawn:[0,4],special:[0,1,3,4],specif:0,specifi:3,specimen:5,spell:[],spend:4,sphinx:[0,1,2,3,4,5,6,7,8,9,10,11,12],sport:4,src:4,stabl:4,stack:4,stage:[],stage_dir:4,stai:[0,4],standard:[],start:[],starter:0,stash:4,state:[0,1,4],statu:[0,4],stderr:[],stdout:[],step:4,sth:[],still:4,stop:0,store:[0,4,11],stori:4,str:[0,5,6,8],straight:4,strict:4,string:5,strip:11,structuralgaplist:11,sub:4,subclass:[],subdir:4,subject:4,submodul:4,submodule1:4,subsequ:11,subtre:[3,4],success:[5,6],suffix:5,suggest:4,suit:[0,4],supervis:0,support:[0,4,5],suppos:4,sure:4,system:[0,1,2,3,4],take:[4,11],talk:0,target:[0,1,3,4],task:4,tell:[0,4,5],templat:[0,11],template_structur:11,temporarili:4,term:4,termin:[0,5],test:[],test_:4,test_action_:0,test_action_awesom:4,test_action_do_awesom:0,test_action_help:0,test_awesome_featur:4,test_foo:3,test_sidechain:4,test_someth:4,test_submodule1:4,test_suite_:3,test_suite_your_module_run:4,test_your_modul:4,testcas:[0,4],testexit0:[0,4],testfileexistsfals:4,testpmexist:0,testutil:[0,4],text:0,than:4,thei:[1,4],them:[3,4],therefor:4,thi:[0,1,3,4,5,7,8,11],thing:[0,1,4],think:4,thoroughli:4,those:[0,1,3,4],three:[0,3,4],through:[0,4],throughout:4,thu:5,tidi:4,tightli:4,time:[0,4,11],tini:4,togeth:4,too:4,tool:[3,5],toolbox:4,top:[1,4,8],topic:[0,4],touch:[0,4],toward:4,track:5,tradition:[5,6],treat:[4,11],tree:[0,3,4],trhough:[],tri:11,trick:[0,4],trigger:[0,3,4],tripl:5,trustworthi:4,tupl:5,turn:[0,4,5],tutori:4,two:[0,4],txt:[0,1,3,4],type:[0,5,11],uncertain:4,under:[3,4],underscor:0,understand:4,unexpect:1,unfortun:4,unit:[],unittest:[0,4],unix:4,unrecognis:5,until:4,untrack:0,unus:4,updat:4,url:4,usabl:4,user:[],userlevel:0,usr:4,usual:[0,1,3,4],utilis:[4,5],valid:4,valu:[1,5,6],vanish:4,vari:3,variabl:[0,1,4],variou:[0,1,3,4],verbos:0,veri:[0,4,5],verifi:[0,4,5],version:[1,4],version_great:4,via:[0,4,8],view:4,virtual:4,wai:[0,1,3,4],wait:4,walk:[0,4],want:[0,1,4,8],warn:4,watch:4,web:[1,4],well:[1,3,4,11],went:4,were:4,what:[0,1,4,5],when:[0,3,4,11],whenev:4,where:[0,4],whether:5,which:[0,1,4,6,7,11],whistl:4,whole:[0,4,11],why:[0,4],wild:3,wise:3,within:[1,4],without:[0,3,4,5,11],wno:4,word:3,work:[0,1,3,4],worst:4,would:[0,1,4,6],wrapper:[0,4,8],wrong:1,www:4,year:0,you:[0,1,3,4,5,8],your:[],your_modul:4,yourself:[1,4]},titles:["<code class=\"docutils literal\"><span class=\"pre\">test_actions.ActionTestCase</span></code> - Testing Actions","Building ProMod3","Changelog","ProMod3‘s Share Of CMake","Contributing","<code class=\"docutils literal\"><span class=\"pre\">argcheck</span></code> - Standard Tests For Command Line Arguments","<code class=\"docutils literal\"><span class=\"pre\">helper</span></code> - Shared Functionality For the Everything","<code class=\"docutils literal\"><span class=\"pre\">core</span></code> - ProMod3 Core Functionality","<code class=\"docutils literal\"><span class=\"pre\">SetCompoundsChemlib()</span></code>","Documentation For Developes","Welcome To ProMod3’s Documentation!","<code class=\"docutils literal\"><span class=\"pre\">rawmodel</span></code> - Coordinate Modeling","Documentation For Users"],titleterms:{"function":[3,6,7],"import":[],action:[0,3,4],actiontestcas:0,api:[0,11],argcheck:5,argument:5,bc2:[],bienert:[],bin:[],branch:4,build:1,chang:2,changelog:2,cmake:[0,1,3,4],command:5,contribut:4,coordin:11,core:7,creat:0,depend:1,develop:9,directori:4,document:[3,4,9,10,12],each:[],everyth:6,execut:0,file:5,git:4,have:0,help:[],helper:6,home:[],hook:4,how:4,indic:10,integr:0,introduct:[3,5,6],issu:4,licens:4,line:5,mainten:3,make:[0,1],messag:6,model:11,modul:[3,4],must:0,output:0,own:4,parti:4,promod3:[1,3,7,10],raw:11,rawmodel:11,releas:2,respond:[],run:[0,1],schwede:[],script:0,setcompoundschemlib:8,share:[3,6],should:[],stage:4,standard:5,start:4,stderr:[],stdout:[],structur:4,subclass:0,tabl:10,test:[0,3,4,5],test_act:0,third:4,unit:[0,3,4],user:12,welcom:10,write:4,your:4}}) \ No newline at end of file +Search.setIndex({envversion:46,filenames:["actions/index_dev","buildsystem","changelog","cmake/index","contributing","core/argcheck","core/helper","core/index","core/pm3argparse","core/setcompoundschemlib","developers","index","rawmodel/index","users"],objects:{"":{"command:add_doc_dependency":[3,0,1,""],"command:add_doc_source":[3,0,1,""],"command:pm_action":[3,0,1,""],"command:promod3_unittest":[3,0,1,""],test_actions:[0,1,0,"-"]},"promod3.core":{pm3argparse:[8,1,0,"-"]},"promod3.core.argcheck":{FileExists:[5,2,1,""],FileExtension:[5,2,1,""]},"promod3.core.helper":{MsgErrorAndExit:[6,2,1,""]},"promod3.core.pm3argparse":{PM3ArgumentParser:[8,5,1,""]},"promod3.core.pm3argparse.PM3ArgumentParser":{"__init__":[8,3,1,""],Parse:[8,3,1,""],action:[8,4,1,""]},"promod3.rawmodel":{BuildRawModel:[12,2,1,""],RawModelingResult:[12,5,1,""]},"promod3.rawmodel.RawModelingResult":{gaps:[12,4,1,""],model:[12,4,1,""]},"test_actions.ActionTestCase":{RunAction:[0,3,1,""],RunExitStatusTest:[0,3,1,""],pm_action:[0,4,1,""],pm_bin:[0,4,1,""],testPMExists:[0,3,1,""]},promod3:{SetCompoundsChemlib:[9,2,1,""],core:[7,1,0,"-"],rawmodel:[12,1,0,"-"]},test_actions:{ActionTestCase:[0,5,1,""]}},objnames:{"0":["cmake","command","CMake command"],"1":["py","module","Python module"],"2":["py","function","Python function"],"3":["py","method","Python method"],"4":["py","attribute","Python attribute"],"5":["py","class","Python class"]},objtypes:{"0":"cmake:command","1":"py:module","2":"py:function","3":"py:method","4":"py:attribute","5":"py:class"},terms:{"2b1":1,"__init__":[0,4,8],"__main__":[0,4],"__name__":[0,4],"_descattr":[],"_opt":4,"_run":[0,3],"_xml":3,"boolean":5,"break":[3,4],"case":4,"class":[0,4,7,8,12],"default":[0,1,4,8,9],"final":[4,12],"import":[],"int":[0,5,6],"new":[0,4,8,12],"public":4,"return":[0,5,6,8,9,12],"short":4,"static":4,"switch":4,"throw":0,"true":[0,4,5,8,12],"try":[0,4],"var":[],"while":[0,3,4,5],abil:4,abort:4,about:[0,3,4,12],abov:[0,4],absolut:3,academ:4,accord:4,achiev:4,acid:12,acknowledg:4,across:0,action_rst:[],action_unit_test:0,actiontest:0,activ:[4,8],actual:4,add:[0,3,4],add_argu:5,add_changelog_to_doc:4,add_custom_target:4,add_doc_depend:3,add_doc_sourc:[3,4],add_subdirectori:4,addit:[3,4,5],addition:[0,3],additional_make_clean_fil:4,admir:4,advic:4,advis:4,affect:4,after:[0,1,4],again:[1,4],ago:0,algorithm:[4,12],alias:4,align:[8,12],all:[0,1,3,4,5,8,12],allow:4,almost:3,aln:12,alon:6,along:[0,4],alot:4,alreadi:[0,3,4],also:[0,1,3,4,5,12],alwai:[0,4],amino:12,ancient:9,ani:[0,3,4,9],announc:[0,4],anyth:[1,4,9],anywai:4,apart:0,api:[],appli:[4,9],applic:0,approach:4,arg:[0,4,8],argpars:[],argument:[],argumentpars:[5,8],argv:8,around:[0,4],ask:4,assertequ:4,assum:[0,4],atom:12,attach:[3,12],attachview:12,attent:[0,4],attr:[],attribut:[4,8],author:4,autom:3,automat:[0,4,5],automatis:4,avail:[0,1,4,9],avoid:[4,9],awai:4,awar:4,awesom:[0,4],awesomeactiontest:4,back:[0,4],backbon:12,background:1,bar:[],base:[5,12],basi:[3,4],basic:[0,1,4,12],becaus:[1,4],been:4,befor:[0,3,4],begin:[0,4],behav:0,behaviour:8,behind:4,bell:4,belong:[3,4],below:4,besid:[1,3,8],best:3,between:0,beyond:8,bienchen:4,bin:[],binari:[0,4],bit:[0,1,4],bla:[],blank:4,block:[],bool:[0,5,8],boost:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],boost_include_dir:4,boost_root:1,branchnam:4,brew:3,briefli:4,bring:4,broken:0,bug:4,builder:1,buildrawmodel:12,built:[3,4],bunch:[0,4,8],bytecod:0,cach:[1,4],call:[0,1,3,4,8,9],calpha:12,calpha_onli:12,came:4,can:[0,1,4,5,8,9,12],cannot:4,captur:0,carri:[4,5],categori:3,caus:4,certain:[0,1,3,4],certainli:0,chain:[4,12],chanc:4,chapter:4,charact:8,charg:4,check:[0,1,4,5,8],checkout:4,chemic:9,child:8,childclass:0,chmod:4,clean:[1,4],clip:8,clone:4,close:4,clutter:[0,4],cmake_build_typ:4,cmake_c_compiler_vers:4,cmake_compiler_is_gnucxx:4,cmake_current_source_dir:4,cmake_cxx_compiler_vers:4,cmake_cxx_flag:4,cmake_cxx_flags_releas:4,cmake_minimum_requir:4,cmake_module_path:4,cmake_source_dir:4,cmake_support:[3,4],cmakecach:1,cmakelist:[0,1,3,4],coars:4,code:[0,1,3,4,5,6,8,9],codetest:[3,4],collect:6,come:[0,3,4,5,8],comfort:5,command:[],comment:4,commerci:4,commit:4,common:[4,5,8],compat:4,compil:[0,4],complain:0,complaint:4,complet:[4,12],complex:4,compon:[4,9],compound:9,compress:5,concept:4,condit:4,conf:[1,4],config:4,configur:[1,4],conflict:4,connect:[3,4],conop:4,conquer:4,consid:[3,4],consist:4,contain:[0,1,3,4,5,12],content:[4,10,11],continu:0,contribut:[],control:4,conveni:0,convent:0,convert:12,coordin:[],cope:4,copi:[3,4,12],core:[],correspond:4,could:[0,3,4,12],coupl:[0,4],cours:4,cover:[0,4,5,7],creat:[],croak:4,crucial:4,current:4,custom:4,cxx:4,dai:5,dare:3,data1:3,data2:3,data:[0,3,4],date:4,dbg:4,debug:4,decent:9,decid:4,declar:[3,4],dedic:[1,3,4],def:[0,4],defin:[0,3,9],definit:4,delet:12,deliv:0,dep:3,dependency1:3,dependency2:3,deriv:0,dervi:[],descattr:[],describ:[3,5],descript:[4,8],design:[0,5],detail:[4,12],detect:5,determin:5,deuterium:12,develop:[],devot:7,dictionari:9,did:4,differ:[0,1,3,4,9],dir:4,direct:4,directori:[],dirti:0,disabl:[0,4],disable_disable_doctest:4,disable_disable_linkcheck:4,disable_doctest:[1,4],disable_document:[1,4],disable_linkcheck:[1,4],displai:5,distribut:[0,4],dive:4,diverg:4,doawesomeactiontest:0,doc:[1,3,4],doctest:[1,4],document:[],doe:[0,3,4,5,9,12],don:[1,4],done:[0,4],dont_write_bytecod:[0,4],doptim:4,dost_root:[1,4],down:8,download:1,dqmean_root:[1,4],drawback:4,driven:4,drop:4,due:12,dure:0,each:[],easi:4,easier:[0,4],easili:[3,4],echo:4,editor:0,educ:4,effect:[3,4],eigen3:4,eigen3_found:4,eigen3_include_dir:[1,4],eigen:[1,4],eigenvalu:4,eigenvector:4,either:[4,12],elabor:4,element:0,els:4,emerg:0,emploi:4,empti:[4,6],enabl:[0,5,9],end:[0,1,3,4,5,6],endif:4,enough:4,entiti:4,entityhandl:12,entri:4,enumer:4,env:4,environ:[0,4],error:[5,6],essenti:4,etc:[0,4],evalu:[3,4],even:[1,4],eventu:8,ever:4,everi:[0,4,12],everybodi:4,everyth:[],exactli:1,exampl:[0,1,4,8,12],except:4,exclud:4,exclus:[0,4],exec_program:4,execut:[],executable_output_path:4,exist:[0,3,4,5],exit:[0,5,6,8],exit_cod:0,exit_statu:[5,6],exot:4,expand:4,expect:0,explain:4,explan:4,ext:5,extend:[0,3,4],extens:[5,8],extern:[3,4],extra:4,extract:4,fail:[0,4,6],failur:[4,5],fals:[0,4,5,8,12],fasta:12,fatal_error:4,favourit:0,featur:4,fed:[3,4],fedora:4,feed:3,feel:4,fellow:4,fetch:[4,5],few:[1,4,12],figur:4,file:[],filecheck:4,fileexist:5,fileextens:5,filenam:4,files_to_be_remov:4,fill:[3,4],find:[3,4],find_packag:4,fine:4,fire:0,first:[0,2,4,8],fix:[4,5],flag1:3,flag2:3,flag:[3,4,5],flush:[0,4],fno:4,folder:4,follow:[0,4,12],foo:[],forbidden:4,forg:4,forget:[0,1,4],format:[4,8],formatt:4,formatter_class:[],forward:4,found:[0,3,4],foundat:0,frame:4,framework:4,free:4,from:[0,1,2,3,4,5,6,12],front:[0,1,4,5],full:[0,4],fulli:4,functions_specific_to_your_act:4,funni:[1,4],gap:12,gather:[3,4,7],gcc:4,gener:[0,4],generalis:4,get:[0,1,4],git:[],gitignor:4,give:[3,4],given:[0,3,5,8],global:9,gly:12,goal:0,goe:[1,4],good:[3,4],got:1,grain:4,grep:1,grow:12,gui:4,gzip:5,hand:[1,3,8],handl:12,happen:[0,4],have:[],headach:4,header:[1,4],header_stage_path:4,headlin:4,help:[],helpactiontest:[],helper:[],henc:4,here:[0,1,3,4,5,6,8,12],hide:4,hierarchi:9,higher:1,highest:9,highli:1,hint:8,histori:4,hit:[0,4],hold:12,home:[],homolog:7,honour:12,host:[3,4],hotfix:4,hous:4,html:[1,2,4],http:4,hydrogen:12,hyphen:0,idea:[0,2,4],identifi:8,ignor:12,imagin:4,imaginari:0,immedi:[0,4,9],implement:4,implicit:1,includ:[2,4,5],include_directori:4,incomplet:12,inconveni:4,incred:12,index:[4,11],indic:[],influenc:8,info:[],inform:[4,8,12],inherit:0,init:4,initi:2,initialis:0,inlin:4,inport:[],input:[0,5,8],insert:12,insid:[0,3],insight:4,instal:[1,4],instanc:8,instead:[0,1,3,4,5],integr:[],intend:[0,4],interest:0,interfac:4,intermedi:4,intern:[0,3,4],internet:4,interpret:[4,6],intervent:4,introduc:[0,3,4],invok:[1,3,4,9],involv:4,item:[0,4,12],itself:[3,4],job:4,just:[0,1,4,8,9],keep:[0,3,4,8],kic:4,kick:8,kill:[],kind:[0,4],know:1,known:[3,5],kwarg:[0,4],label:4,languag:3,lapack:[1,4],last:[0,3],later:[0,4],latest:1,latter:4,launcher:[3,4],lead:[4,5],least:[1,3,4],leav:0,left:6,legal:4,less:4,let:[0,4],level:[1,4,9],lib_stage_path:4,libexec:[3,4],libexec_stage_path:4,librari:[3,4,9],library1:3,library2:3,life:4,like:[0,1,3,4,12],line:[],lineno:[],link:[1,3,4],linkcheck:[1,4],linker:3,list:[0,1,3,4,5,8,12],littl:[3,4],live:[3,4],load:[0,9],loadalign:12,loadpdb:12,locat:[1,3],log:[4,6],look:[4,5],loop:[4,12],loss:4,lost:[0,4],lot:[0,4,5,8],low:0,macro:[3,4],made:3,magic:4,mai:[0,1,3,4,12],main:[],mainattr:[],maintain:4,major:4,make_directori:4,makefil:[1,4],malici:4,man:[1,4],manag:[3,4],mandatori:4,mani:6,manner:4,manual:[0,1,4],markup:4,master:4,match:[3,4,12],materi:[0,4],matter:3,mean:[1,3,4,5,8],meld:2,member:[4,12],mention:0,merg:4,mess:4,messag:[],messi:4,methionin:12,method:0,middl:4,mind:[0,4],minimalist:12,miss:[5,12],mix:3,mkdir:4,mmcif:5,mod:4,mode:0,model:[],modif:12,modifi:[2,4,12],modul:[],mol:4,mol_alg:4,moment:4,monitor:0,monolith:4,mood:4,more:[0,1,3,4,12],most:[3,4,5,12],mostli:[3,4],move:4,msg:6,msgerrorandexit:6,much:[4,12],multipl:4,must:[],name:[0,3,4,5,8],namespac:8,need:[0,1,3,4,5,8,9],neg:0,never:4,nevertheless:4,next:[0,4],nice:4,nobodi:0,non:4,none:8,note:[4,8],noth:[3,4],notic:[0,3,4],now:[0,4,12],number:[0,12],obtain:12,obviou:4,off:[0,4,12],often:[4,5,8],onc:[0,4],onli:[0,3,4,5,9,12],onto:0,openstructur:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],oper:4,opt:[4,5],optim:[1,4],optimis:4,option:[1,4,5],org:4,origin:4,ost:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],ost_doc_url:4,ost_double_precis:1,ost_include_dir:4,ost_root:[1,4],other:[0,1,4,12],otherwis:[0,3,4],ouput:[],our:[3,4],out:[0,1,3,4],output:[],output_vari:4,outsid:4,over:[1,3,4,12],overli:4,overview:4,own:[],packag:[3,4],page:[1,4,11],pai:0,paragraph:[0,4],param:[],paramet:[0,3,5,6,8,9,12],parent:12,pars:[],parse_arg:[5,8],part:[0,4],particular:4,pass:4,past:4,path:[0,1,3,4,5],path_to_chemlib:9,pdb:[5,12],peopl:4,pep:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],peptid:12,per:[3,4,7],perfect:4,perfectli:4,perform:4,permiss:4,phosphoserin:12,phrase:4,pictur:4,piec:4,place:[0,4,6],pleas:4,plu:[4,8,9],pm3_csc:4,pm3argumentpars:8,pm_action:[0,3,4],pm_action_init:4,pm_bin:0,point:[1,4,9],pointer:1,pop:4,popul:[1,4],posit:5,possibl:[4,8,12],practic:[3,4],pre:4,pre_commit:4,prefer:3,prefix:[0,3,4,5],prepar:4,prevent:[0,4],print:[0,1],privat:0,probabl:[1,3,4],problem:4,process:[0,4],produc:[0,1,3,4],product:[0,4],prog:8,program:[3,4,7],project:[3,4],project_binary_dir:4,project_nam:4,promod3_unittest:[0,3,4],promod3_version_major:4,promod3_version_minor:4,promod3_version_patch:4,promod3_version_str:4,promod_gcc_45:4,promot:4,propag:4,proper:4,properli:0,properti:4,protein:12,provid:[0,1,3,4,8],pseudo:12,pull:[1,4],punch:0,purpos:4,push:4,put:[0,1,3,4,5],py_run:[0,3,4],pyc:[0,4],pylint:4,pylintrc:4,pymod:4,python:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],python_binari:4,python_doc_url:4,python_root:1,python_vers:4,qmean:[1,4],qmean_include_dir:4,qmean_root:[1,4],quickli:4,quit:[4,8],rais:12,rare:4,rather:[4,6,8],raw:[],rawmodel:[],rawmodelingresult:12,read:4,readabl:4,reader:4,readi:1,real:[4,8],realli:[0,1,4,5],reappear:4,reason:4,rebas:4,rebuild:[1,4],recent:4,recognis:[0,4],recommend:1,record:0,refer:[0,3],regist:[3,4],rel:3,relat:[3,4],relev:[1,3],rememb:0,remov:1,renam:2,renumb:12,report:[0,4,12],repositori:[0,2,3,4],requir:[1,4],resembl:4,reserv:[5,6],residu:12,resolv:4,respons:4,rest:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],restrict:4,restrict_chain:12,restructuredtext:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],result:[1,4,12],reus:12,review:4,reviv:4,rewrit:0,right:[0,1,4],role:[],root:[3,4],routin:0,rst1:3,rst2:3,rst:[3,4],rule:4,runact:0,runexitstatustest:[0,4],runnabl:4,runtest:[0,4],runtimeerror:12,sake:[],same:[0,1,3,4,8],sampl:[],save:4,savepdb:12,scenario:[],scheme:[0,4,8],script:[],seamlessli:4,search:[1,4,11],second:12,secondli:4,section:[0,3],see:[0,4],seem:4,select:12,selenium:12,self:[0,4],send:6,separ:[0,4],seq:[4,12],seq_alg:4,sequenc:[8,12],serv:[0,8],servic:4,set:[0,1,3,4,5,8,9,12],set_directory_properti:4,setup:[2,4],setup_boost:4,setup_compiler_flag:4,setup_stag:4,sever:[1,4,8],shebang:4,shell:[0,1,4,5,6],should:[],show:[0,4],shown:4,side:[4,12],sidechain:4,sidechains_pymod:4,sidechains_rst:4,sidechains_unit_test:4,silent:0,similar:[0,1,4],simplest:4,simplif:8,sin:[],sinc:[0,1,3,4,5],singl:[3,4,12],sit:4,skip:[0,4],smallish:[1,4],smart:4,smng:2,softwar:4,sole:[0,4],solut:4,solv:4,solver:4,some:[0,1,3,4,5,8],somebodi:[],someth:[0,4,6],somethingtest:4,sometim:4,somewher:3,soon:4,sort:[0,3],sound:4,sourc:[0,1,3,4,5,6,8,9],source1:[3,4],source2:[3,4],spawn:[0,4],special:[0,1,3,4],specif:0,specifi:3,specimen:5,spell:[],spend:4,sphinx:[0,1,2,3,4,5,6,7,8,9,10,11,12,13],sport:4,src:4,stabl:4,stack:4,stage:[],stage_dir:4,stai:[0,4],standard:[],start:[],starter:0,stash:4,state:[0,1,4],statu:[0,4],stderr:[],stdout:[],step:4,sth:[],still:4,stop:0,store:[0,4,12],stori:4,str:[0,5,6,8,9],straight:4,strict:4,string:[5,8],strip:12,structuralgaplist:12,sub:4,subclass:[],subdir:4,subject:4,submodul:4,submodule1:4,subsequ:12,subtre:[3,4],success:[5,6],suffix:5,suggest:4,suit:[0,4],supervis:0,support:[0,4,5],suppos:4,sure:4,synopsi:[],system:[0,1,2,3,4],take:[4,12],talk:0,target:[0,1,3,4,8],task:4,tell:[0,4,5],templat:[0,8,12],template_structur:12,temporarili:4,term:4,termin:[0,5],test:[],test_:4,test_action_:0,test_action_awesom:4,test_action_do_awesom:0,test_action_help:0,test_awesome_featur:4,test_foo:3,test_sidechain:4,test_someth:4,test_submodule1:4,test_suite_:3,test_suite_your_module_run:4,test_your_modul:4,testcas:[0,4],testexit0:[0,4],testfileexistsfals:4,testpmexist:0,testutil:[0,4],text:[0,8],than:[4,8],thei:[1,4],them:[3,4],therefor:4,thi:[0,1,3,4,5,7,8,9,12],thing:[0,1,4],think:4,thoroughli:4,those:[0,1,3,4],three:[0,3,4],through:[0,4],throughout:[4,8],thu:5,tidi:4,tightli:4,time:[0,4,12],tini:4,togeth:4,too:4,tool:[3,5],toolbox:4,top:[1,4,9],topic:[0,4],touch:[0,4],toward:4,track:5,tradit:8,tradition:[5,6],treat:[4,12],tree:[0,3,4],trhough:[],tri:12,trick:[0,4],trigger:[0,3,4],tripl:5,trustworthi:4,tupl:5,turn:[0,4,5],tutori:4,two:[0,4],txt:[0,1,3,4],type:[0,5,8,12],uncertain:4,under:[3,4],underli:[],underscor:0,understand:4,unexpect:1,unfortun:4,unit:[],unittest:[0,4],unix:4,unrecognis:[5,8],until:4,untrack:0,unus:4,updat:4,url:4,usabl:4,user:[],userlevel:0,usr:4,usual:[0,1,3,4,8],utilis:[4,5],valid:4,valu:[1,5,6],vanish:4,vari:3,variabl:[0,1,4],variou:[0,1,3,4],verbos:0,veri:[0,4,5],verif:8,verifi:[0,4,5],version:[1,4],version_great:4,via:[0,4,8,9],view:4,virtual:4,wai:[0,1,3,4,8],wait:4,walk:[0,4],want:[0,1,4,9],warn:4,watch:4,web:[1,4],well:[1,3,4,12],went:4,were:4,what:[0,1,4,5,8],when:[0,3,4,12],whenev:4,where:[0,4],whether:5,which:[0,1,4,6,7,8,12],whistl:4,whole:[0,4,12],why:[0,4],wild:3,wise:3,within:[1,4],without:[0,3,4,5,12],wno:4,word:3,work:[0,1,3,4],worst:4,would:[0,1,4,6],wrapper:[0,4,9],wrong:1,www:4,year:0,you:[0,1,3,4,5,8,9],your:[],your_modul:4,yourself:[1,4]},titles:["<code class=\"docutils literal\"><span class=\"pre\">test_actions.ActionTestCase</span></code> - Testing Actions","Building ProMod3","Changelog","ProMod3‘s Share Of CMake","Contributing","<code class=\"docutils literal\"><span class=\"pre\">argcheck</span></code> - Standard Tests For Command Line Arguments","<code class=\"docutils literal\"><span class=\"pre\">helper</span></code> - Shared Functionality For the Everything","<code class=\"docutils literal\"><span class=\"pre\">core</span></code> - ProMod3 Core Functionality","<code class=\"docutils literal\"><span class=\"pre\">pm3argparse</span></code> - Parsing Command Lines","<code class=\"docutils literal\"><span class=\"pre\">SetCompoundsChemlib()</span></code>","Documentation For Developes","Welcome To ProMod3’s Documentation!","<code class=\"docutils literal\"><span class=\"pre\">rawmodel</span></code> - Coordinate Modeling","Documentation For Users"],titleterms:{"function":[3,6,7],"import":[],action:[0,3,4],actiontestcas:0,api:[0,12],argcheck:5,argpars:[],argument:[5,8],bc2:[],bienert:[],bin:[],branch:4,build:1,chang:2,changelog:2,cmake:[0,1,3,4],command:[5,8],contribut:4,coordin:12,core:7,creat:0,depend:1,develop:10,directori:4,document:[3,4,10,11,13],each:[],everyth:6,execut:0,file:5,foo:[],git:4,have:0,help:[],helper:6,home:[],hook:4,how:4,indic:11,integr:0,introduct:[3,5,6,8],issu:4,licens:4,line:[5,8],mainten:3,make:[0,1],messag:6,model:12,modul:[3,4],must:0,output:0,own:4,pars:8,parser:8,parti:4,pm3argpars:8,promod3:[1,3,7,11],raw:12,rawmodel:12,releas:2,respond:[],run:[0,1],schwede:[],script:0,setcompoundschemlib:9,share:[3,6],should:[],stage:4,standard:5,start:4,stderr:[],stdout:[],structur:4,stuff:[],subclass:0,tabl:11,test:[0,3,4,5],test_act:0,third:4,unit:[0,3,4],user:13,welcom:11,write:4,your:4}}) \ No newline at end of file