diff --git a/doc/html/.doctrees/buildsystem.doctree b/doc/html/.doctrees/buildsystem.doctree index 5f9e2c5f075b2f98ea8153f7f77e0dc10fb896f1..2fb7ff2b8e5d02d46cceac30a5d15ef878f572be 100644 Binary files a/doc/html/.doctrees/buildsystem.doctree and b/doc/html/.doctrees/buildsystem.doctree differ diff --git a/doc/html/.doctrees/changelog.doctree b/doc/html/.doctrees/changelog.doctree index d14fd28689a1e1aa6b7f31fe9206d132f07e49be..d0599ee2fd2f720fc3f49b08fc37e8b9bcc3290a 100644 Binary files a/doc/html/.doctrees/changelog.doctree and b/doc/html/.doctrees/changelog.doctree differ diff --git a/doc/html/.doctrees/contributing.doctree b/doc/html/.doctrees/contributing.doctree index b7270fcd1c9444295a5bd86354bd7c8d7d20157c..cd3a762ae78de5d13235855bb513b6c66f4b48b1 100644 Binary files a/doc/html/.doctrees/contributing.doctree and b/doc/html/.doctrees/contributing.doctree differ diff --git a/doc/html/.doctrees/core/argcheck.doctree b/doc/html/.doctrees/core/argcheck.doctree index c538dc0792872b91b92df310d53c17d5a303aeb0..5e14a0f004a1d59ca4c4331864bb69755712ee3f 100644 Binary files a/doc/html/.doctrees/core/argcheck.doctree and b/doc/html/.doctrees/core/argcheck.doctree differ diff --git a/doc/html/.doctrees/core/index.doctree b/doc/html/.doctrees/core/index.doctree index 2ce0a48df1d52b73d7aeec039753df86b01761f9..6e018ee455d01a5ff5d25885f8c68d5895e156a3 100644 Binary files a/doc/html/.doctrees/core/index.doctree and b/doc/html/.doctrees/core/index.doctree differ diff --git a/doc/html/.doctrees/developers.doctree b/doc/html/.doctrees/developers.doctree index 30600b32fca18052563d582fbd40dd582b72ae55..84da9b65a424669ba1f919955cb5a532d2bad0e2 100644 Binary files a/doc/html/.doctrees/developers.doctree and b/doc/html/.doctrees/developers.doctree differ diff --git a/doc/html/.doctrees/environment.pickle b/doc/html/.doctrees/environment.pickle index 2099d9ed44a91ecaf0445217435d9f12823d3eeb..48afb07ce387b44ebc278cf9e55502182ccc4d32 100644 Binary files a/doc/html/.doctrees/environment.pickle and b/doc/html/.doctrees/environment.pickle differ diff --git a/doc/html/.doctrees/index.doctree b/doc/html/.doctrees/index.doctree index 48bdc621eadfd883f20a31cf5ba416b4c7f3d96c..abd92e5f93ce86f3cd7ae1b11097f731c3454734 100644 Binary files a/doc/html/.doctrees/index.doctree and b/doc/html/.doctrees/index.doctree differ diff --git a/doc/html/.doctrees/meld/index.doctree b/doc/html/.doctrees/meld/index.doctree index 4421e0f8b9d6bebb167930640db7132592140f48..aee602ffc10f87bf7e1dbebdf9ea59b38ea86234 100644 Binary files a/doc/html/.doctrees/meld/index.doctree and b/doc/html/.doctrees/meld/index.doctree differ diff --git a/doc/html/.doctrees/meld/loop.doctree b/doc/html/.doctrees/meld/loop.doctree index 540bcc07b0e6b82f8fcc683364cffbe12287986f..9ada519758867fc9d74baa48009eea65bf15f74b 100644 Binary files a/doc/html/.doctrees/meld/loop.doctree and b/doc/html/.doctrees/meld/loop.doctree differ diff --git a/doc/html/.doctrees/meld/rawmodel.doctree b/doc/html/.doctrees/meld/rawmodel.doctree index 78503f04f2aba7fcffafc912c4227cd0be08e307..51747294b6e754df7f3a094d947577c373ea1576 100644 Binary files a/doc/html/.doctrees/meld/rawmodel.doctree and b/doc/html/.doctrees/meld/rawmodel.doctree differ diff --git a/doc/html/.doctrees/users.doctree b/doc/html/.doctrees/users.doctree index 72fa011da097a545a83fd5ba6046696fba77dda7..ac4d870c25b776223eafcbe016fe9a8312cd05a8 100644 Binary files a/doc/html/.doctrees/users.doctree and b/doc/html/.doctrees/users.doctree differ diff --git a/doc/html/_modules/index.html b/doc/html/_modules/index.html index 30923bd52cb8a7c485414dfc7c06005493f56d59..e9d171da247be33dbecd890d76f39bac6e5a66c0 100644 --- a/doc/html/_modules/index.html +++ b/doc/html/_modules/index.html @@ -85,7 +85,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/_modules/promod3/core/argcheck.html b/doc/html/_modules/promod3/core/argcheck.html index c91c0ab7ccc167f704ea65318ffba146d8339b70..c1a3e1a187759bec0707d795f6f6737ad338ab0a 100644 --- a/doc/html/_modules/promod3/core/argcheck.html +++ b/doc/html/_modules/promod3/core/argcheck.html @@ -69,7 +69,7 @@ <span class="sd"> missing.</span> <span class="sd"> '''</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="nb">file</span><span class="p">):</span> - <span class="k">print</span> <span class="s">'</span><span class="si">%s</span><span class="s"> file does not exist: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="nb">file</span><span class="p">)</span> + <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> file does not exist: </span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="nb">file</span><span class="p">))</span> <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">exit_status</span><span class="p">)</span> </div> <div class="viewcode-block" id="FileExtension"><a class="viewcode-back" href="../../../core/argcheck.html#promod3.core.argcheck.FileExtension">[docs]</a><span class="k">def</span> <span class="nf">FileExtension</span><span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="n">exit_status</span><span class="p">,</span> <span class="nb">file</span><span class="p">,</span> <span class="n">extensions</span><span class="p">,</span> <span class="n">gz</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span> @@ -113,10 +113,10 @@ <span class="n">is_gz</span> <span class="o">=</span> <span class="bp">True</span> <span class="n">filename</span><span class="p">,</span> <span class="n">fileext</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">splitext</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">gz</span><span class="p">:</span> - <span class="k">print</span> <span class="s">'</span><span class="si">%s</span><span class="s"> file extension not supported: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="nb">file</span><span class="p">)</span> + <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> file extension not supported: </span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="nb">file</span><span class="p">))</span> <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">exit_status</span><span class="p">)</span> <span class="k">if</span> <span class="n">fileext</span> <span class="o">==</span> <span class="s">''</span><span class="p">:</span> - <span class="k">print</span> <span class="s">'</span><span class="si">%s</span><span class="s"> file extension not supported: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="nb">file</span><span class="p">)</span> + <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> file extension not supported: </span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="nb">file</span><span class="p">))</span> <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">exit_status</span><span class="p">)</span> <span class="n">fileext</span> <span class="o">=</span> <span class="n">fileext</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="k">for</span> <span class="n">ext</span> <span class="ow">in</span> <span class="n">extensions</span><span class="p">:</span> @@ -125,7 +125,7 @@ <span class="k">return</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">filename</span><span class="p">),</span> <span class="n">fileext</span><span class="p">,</span> <span class="n">is_gz</span> <span class="k">else</span><span class="p">:</span> <span class="k">return</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">filename</span><span class="p">),</span> <span class="n">fileext</span> - <span class="k">print</span> <span class="s">'</span><span class="si">%s</span><span class="s"> file extension not supported: </span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="nb">file</span><span class="p">)</span> + <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">'</span><span class="si">%s</span><span class="s"> file extension not supported: </span><span class="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">prefix</span><span class="p">,</span> <span class="nb">file</span><span class="p">))</span> <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="n">exit_status</span><span class="p">)</span> </div> <span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span> @@ -133,7 +133,8 @@ <span class="s">'FileExtension'</span><span class="p">,</span> <span class="p">)</span> -<span class="c"># LocalWords: gz pdb gzip bool</span> +<span class="c"># LocalWords: gz pdb gzip bool os sys FileExists FileExtension filename</span> +<span class="c"># LocalWords: fileext</span> </pre></div> </div> @@ -173,7 +174,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/_sources/buildsystem.txt b/doc/html/_sources/buildsystem.txt index c4124270a1741bec5e4448b7ca28d39b0f812fe3..fbb9656f7142cfcb43fa62643f03ca3e3cb866e2 100644 --- a/doc/html/_sources/buildsystem.txt +++ b/doc/html/_sources/buildsystem.txt @@ -36,9 +36,9 @@ put a ``-D`` in front of options. Here is a list of more options used within |project|: * ``DISABLE_DOCUMENTATION`` Don't build documentation, don't search for |sphinx| -* ``DISABLE_DOCTEST`` Don't run example code from documentation on 'make check' - (implicit by ``DISABLE_DOCUMENTATION``) -* ``DISABLE_LINKCHECK`` Don't test links from documentation on 'make check +* ``DISABLE_DOCTEST`` Don't run example code from documentation on + ``make check`` (implicit by ``DISABLE_DOCUMENTATION``) +* ``DISABLE_LINKCHECK`` Don't test links from documentation on ``make check`` (implicit by ``DISABLE_DOCUMENTATION``) Instead of calling |cmake| by yourself, there is the :file:`conf-scripts` @@ -68,7 +68,6 @@ special targets: .. _ost_l: http://www.OpenStructure.org -.. _ost_s: http://www.OpenStructure.org .. _cmake: http://www.cmake.org/ .. _python: https://www.python.org/ .. _boost: http://www.boost.org/ diff --git a/doc/html/_sources/contributing.txt b/doc/html/_sources/contributing.txt index 869300d8702b2334086fa46095eebe7cfa8eac00..e83104db1a5c72517b334c929b4f8bcde1623fce 100644 --- a/doc/html/_sources/contributing.txt +++ b/doc/html/_sources/contributing.txt @@ -269,7 +269,6 @@ version control, create a couple of files which are always needed. .. code-block:: console $ touch sidechains/pymod/__init__.py - $ echo "FOO" >> sidechains/doc/index.rst $ echo ":mod:\`~promod3.sidechains\` - ProMod3 side chain optimiser" >> sidechains/doc/index.rst $ echo "================================================================================" >> sidechains/doc/index.rst $ @@ -330,7 +329,7 @@ a couple of examples around in this repository. Here is the most basic :file:`CMakeLists.txt`: .. code-block:: cmake - :linenos: + :linenos: set(SIDECHAINS_PYMOD __init__.py @@ -348,8 +347,8 @@ The final step towards |cmake| is to register your module's directory in the top level :file:`CMakeLists.txt`: .. code-block:: cmake - :linenos: - :emphasize-lines: 80 + :linenos: + :emphasize-lines: 80 #------------------------------------------------------------------------------- # Author: Bienchen @@ -481,14 +480,90 @@ a new configuration script. The following example assumes |fedora| 19. From this point, :command:`make` should work and you could start adding your files to the repository using ``git add``. +Up to now, we did not cover the :file:`tests` branch of a new module. But its +good practice to develop new functionality along tests and that right from the +beginning. At some point, new code needs testing anyway to see if it does what +it should, so just do this by writing unit tests. Test sources are stored in +files with a prefix :file:`test_` and usually come per submodule instead of +sporting a single monolithic :file:`test_sidechains.py`. + +|python| code is evaluated using its own +:py_docs:`unit testing framework <library/unittest.html>` with a little help +from |ost_s|_. The basic scheme is to import your module, subclass +:class:`unittest.TestCase` and make the whole file runnable as script using the +most common |nameattr|_ attribute. A file :file:`tests/test_something.py` could +look like this, carrying a single test case: + +.. testcode:: promod3unittest + :hide: + + import unittest + + class something(): + @staticmethod + def Else(): + return 1 + + class SomethingTests(unittest.TestCase): + def testFileExistsFalse(self): + self.assertEquals(something.Else(), 1) + + if __name__ == "__builtin__": + suite = unittest.TestLoader().loadTestsFromTestCase(SomethingTests) + unittest.TextTestRunner().run(suite) + +.. code-block:: python + :linenos: + + import unittest + from promod3.sidechains import something + + class SomethingTests(unittest.TestCase): + def testFileExistsFalse(self): + self.assertEquals(something.Else(), 1) + + if __name__ == "__main__": + from ost import testutils + testutils.RunTests() + +To hook up your tests with ``make codetest`` (and to create a +``test_something.py_run`` target), everything has to be introduced to |cmake|. +First, tell |cmake| to search :file:`tests` for a :file:`CMakeLists.txt` file +by extending the list of sub-directories in :file:`sidechains/CMakeLists.txt`: + +.. code-block:: cmake + :linenos: + + add_subdirectory(pymod) + add_subdirectory(doc) + add_subdirectory(tests) + +Then fill :file:`sidechains/tests/CMakeLists.txt` with your new test script and +``make`` will recognise the changes next time it is run and fix the rest for +you. + +.. code-block:: cmake + :linenos: + + set(SIDECHAINS_UNIT_TESTS + test_something.py + ) + + promod3_unittest(MODULE sidechains SOURCES "${SIDECHAINS_UNIT_TESTS}") + +Now tests should be available by ``make check``, ``make codetest`` and +``make test_something.py_run``. + .. _restructuredtext: http://docutils.sourceforge.net/rst.html .. |fedora| replace:: Fedora - +.. |nameattr| replace:: :attr:`__name__` .. LocalWords: cmake hotfix doctest linkcheck rebase BRANCHNAME rebasing py .. LocalWords: CMakeLists txt rst pymod init submodule src restructuredtext .. LocalWords: makefiles formatters Changelog codetest promod sidechains io .. LocalWords: mkdir linenos subdirectory abrv emphasize CXX GNUCXX gcc fno .. LocalWords: ARGS endif OPTIMIZE LIBEXEC Wno DIRS dirs subdirs config dbg -.. LocalWords: changelog Optimized DOPTIMIZE gitignore cd conf +.. LocalWords: changelog Optimized DOPTIMIZE gitignore cd conf subtree attr +.. LocalWords: unittest TestCase nameattr testcode staticmethod builtin +.. LocalWords: SomethingTests testFileExistsFalse testutils RunTests diff --git a/doc/html/buildsystem.html b/doc/html/buildsystem.html index e38c28162d03ba1653564dd8d407b4ebcd14f3b6..82a4b4ce7fdbca0dae91ff5a35f896229bde851f 100644 --- a/doc/html/buildsystem.html +++ b/doc/html/buildsystem.html @@ -88,9 +88,9 @@ put a <tt class="docutils literal"><span class="pre">-D</span></tt> in front of <p>Here is a list of more options used within ProMod3:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">DISABLE_DOCUMENTATION</span></tt> Don’t build documentation, don’t search for Sphinx</li> -<li><tt class="docutils literal"><span class="pre">DISABLE_DOCTEST</span></tt> Don’t run example code from documentation on ‘make check’ -(implicit by <tt class="docutils literal"><span class="pre">DISABLE_DOCUMENTATION</span></tt>)</li> -<li><tt class="docutils literal"><span class="pre">DISABLE_LINKCHECK</span></tt> Don’t test links from documentation on ‘make check +<li><tt class="docutils literal"><span class="pre">DISABLE_DOCTEST</span></tt> Don’t run example code from documentation on +<tt class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></tt> (implicit by <tt class="docutils literal"><span class="pre">DISABLE_DOCUMENTATION</span></tt>)</li> +<li><tt class="docutils literal"><span class="pre">DISABLE_LINKCHECK</span></tt> Don’t test links from documentation on <tt class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></tt> (implicit by <tt class="docutils literal"><span class="pre">DISABLE_DOCUMENTATION</span></tt>)</li> </ul> <p>Instead of calling CMake by yourself, there is the <tt class="file docutils literal"><span class="pre">conf-scripts</span></tt> @@ -186,7 +186,7 @@ configuration also Sphinx with the <tt class="docutils literal"><span class="pre </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/changelog.html b/doc/html/changelog.html index abd8194403d23abe1f5fdfdcda2bbb58d6f34ed4..8c290bd61b248d092825d92bee7c88ea3db5a9e3 100644 --- a/doc/html/changelog.html +++ b/doc/html/changelog.html @@ -127,7 +127,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 13:39, 2014. + Last updated on Jun 14 18:21, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/contributing.html b/doc/html/contributing.html index 559d94b89daddd9ff7b6392e561dcbe06615621f..a523228be31d67cd588947f2bb4f365112156ef8 100644 --- a/doc/html/contributing.html +++ b/doc/html/contributing.html @@ -282,7 +282,6 @@ list of directories which are likely to be used in every project.</p> is, Git does not admire empty directories. Before you bring your module under version control, create a couple of files which are always needed.</p> <div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> touch sidechains/pymod/__init__.py -<span class="gp">$</span> <span class="nb">echo</span> <span class="s2">"FOO"</span> >> sidechains/doc/index.rst <span class="gp">$</span> <span class="nb">echo</span> <span class="s2">":mod:\`~promod3.sidechains\` - ProMod3 side chain optimiser"</span> >> sidechains/doc/index.rst <span class="gp">$</span> <span class="nb">echo</span> <span class="s2">"================================================================================"</span> >> sidechains/doc/index.rst <span class="gp">$</span> @@ -341,11 +340,11 @@ a couple of examples around in this repository. Here is the most basic 2 3 4 -5</pre></div></td><td class="code"><div class="highlight"><pre><span class="nb">set</span><span class="p">(</span><span class="s">SIDECHAINS_PYMOD</span> -<span class="s">__init__.py</span> -<span class="p">)</span> +5</pre></div></td><td class="code"><div class="highlight"><pre> <span class="nb">set</span><span class="p">(</span><span class="s">SIDECHAINS_PYMOD</span> + <span class="s">__init__.py</span> + <span class="p">)</span> -<span class="nb">pymod</span><span class="p">(</span><span class="s">NAME</span> <span class="s">sidechains</span> <span class="s">PY</span> <span class="o">${</span><span class="nv">SIDECHAINS_PYMOD</span><span class="o">}</span><span class="p">)</span> + <span class="nb">pymod</span><span class="p">(</span><span class="s">NAME</span> <span class="s">sidechains</span> <span class="s">PY</span> <span class="o">${</span><span class="nv">SIDECHAINS_PYMOD</span><span class="o">}</span><span class="p">)</span> </pre></div> </td></tr></table></div> <p>Source files should be again listed in a dedicated variable. Later, you @@ -446,98 +445,98 @@ top level <tt class="file docutils literal"><span class="pre">CMakeLists.txt</sp 89 90 91 -92</pre></div></td><td class="code"><div class="highlight"><pre><span class="c">#-------------------------------------------------------------------------------</span> -<span class="c"># Author: Bienchen</span> -<span class="c">#-------------------------------------------------------------------------------</span> -<span class="c"># Options to CMake:</span> -<span class="c"># DISABLE_DOCUMENTATION: Don't build documentation, don't search for Sphinx</span> -<span class="c"># DISABLE_DOCTEST: Don't run example code from documentation on 'make check'</span> -<span class="c"># DISABLE_LINKCHECK: Don't test links from documentation on 'make check'</span> -<span class="c"># (if documentation is disabled, there is no doctest, linkcheck at all)</span> -<span class="nb">cmake_minimum_required</span><span class="p">(</span><span class="s">VERSION</span> <span class="s">2.6.4</span> <span class="s">FATAL_ERROR</span><span class="p">)</span> -<span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_MODULE_PATH</span> <span class="o">${</span><span class="nv">CMAKE_MODULE_PATH</span><span class="o">}</span> <span class="o">${</span><span class="nv">CMAKE_SOURCE_DIR</span><span class="o">}</span><span class="s">/cmake_support</span><span class="p">)</span> +92</pre></div></td><td class="code"><div class="highlight"><pre> <span class="c">#-------------------------------------------------------------------------------</span> + <span class="c"># Author: Bienchen</span> + <span class="c">#-------------------------------------------------------------------------------</span> + <span class="c"># Options to CMake:</span> + <span class="c"># DISABLE_DOCUMENTATION: Don't build documentation, don't search for Sphinx</span> + <span class="c"># DISABLE_DOCTEST: Don't run example code from documentation on 'make check'</span> + <span class="c"># DISABLE_LINKCHECK: Don't test links from documentation on 'make check'</span> + <span class="c"># (if documentation is disabled, there is no doctest, linkcheck at all)</span> + <span class="nb">cmake_minimum_required</span><span class="p">(</span><span class="s">VERSION</span> <span class="s">2.6.4</span> <span class="s">FATAL_ERROR</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_MODULE_PATH</span> <span class="o">${</span><span class="nv">CMAKE_MODULE_PATH</span><span class="o">}</span> <span class="o">${</span><span class="nv">CMAKE_SOURCE_DIR</span><span class="o">}</span><span class="s">/cmake_support</span><span class="p">)</span> -<span class="nb">project</span><span class="p">(</span><span class="s">PROMOD3</span> <span class="s">CXX</span> <span class="s">C</span><span class="p">)</span> + <span class="nb">project</span><span class="p">(</span><span class="s">PROMOD3</span> <span class="s">CXX</span> <span class="s">C</span><span class="p">)</span> -<span class="nb">include</span><span class="p">(</span><span class="s">PROMOD3</span><span class="p">)</span> + <span class="nb">include</span><span class="p">(</span><span class="s">PROMOD3</span><span class="p">)</span> -<span class="nb">set</span><span class="p">(</span><span class="s">PROMOD3_VERSION_MAJOR</span> <span class="s">0</span><span class="p">)</span> -<span class="nb">set</span><span class="p">(</span><span class="s">PROMOD3_VERSION_MINOR</span> <span class="s">1</span><span class="p">)</span> -<span class="nb">set</span><span class="p">(</span><span class="s">PROMOD3_VERSION_PATCH</span> <span class="s">0</span><span class="p">)</span> -<span class="nb">set</span><span class="p">(</span><span class="s">PROMOD3_VERSION_STRING</span> <span class="o">${</span><span class="nv">PROMOD3_VERSION_MAJOR</span><span class="o">}</span><span class="s">.</span><span class="o">${</span><span class="nv">PROMOD3_VERSION_MINOR</span><span class="o">}</span><span class="s">.</span><span class="o">${</span><span class="nv">PROMOD3_VERSION_PATCH</span><span class="o">}</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">PROMOD3_VERSION_MAJOR</span> <span class="s">0</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">PROMOD3_VERSION_MINOR</span> <span class="s">1</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">PROMOD3_VERSION_PATCH</span> <span class="s">0</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">PROMOD3_VERSION_STRING</span> <span class="o">${</span><span class="nv">PROMOD3_VERSION_MAJOR</span><span class="o">}</span><span class="s">.</span><span class="o">${</span><span class="nv">PROMOD3_VERSION_MINOR</span><span class="o">}</span><span class="s">.</span><span class="o">${</span><span class="nv">PROMOD3_VERSION_PATCH</span><span class="o">}</span><span class="p">)</span> -<span class="nb">if</span> <span class="p">(</span><span class="s">CMAKE_COMPILER_IS_GNUCXX</span><span class="p">)</span> - <span class="nb">exec_program</span><span class="p">(</span><span class="s">gcc</span> <span class="s">ARGS</span> <span class="s">--version</span> <span class="s">OUTPUT_VARIABLE</span> <span class="s">CMAKE_C_COMPILER_VERSION</span><span class="p">)</span> - <span class="nb">if</span><span class="p">(</span><span class="s">CMAKE_C_COMPILER_VERSION</span> <span class="s">MATCHES</span> <span class="s2">".*4\\.[5-9].*"</span><span class="p">)</span> - <span class="nb">set</span><span class="p">(</span><span class="s">PROMOD_GCC_45</span> <span class="s">true</span><span class="p">)</span> - <span class="nb">else</span><span class="p">()</span> - <span class="nb">set</span><span class="p">(</span><span class="s">PROMOD_GCC_45</span> <span class="s">false</span><span class="p">)</span> - <span class="nb">endif</span><span class="p">()</span> -<span class="nb">endif</span><span class="p">()</span> + <span class="nb">if</span> <span class="p">(</span><span class="s">CMAKE_COMPILER_IS_GNUCXX</span><span class="p">)</span> + <span class="nb">exec_program</span><span class="p">(</span><span class="s">gcc</span> <span class="s">ARGS</span> <span class="s">--version</span> <span class="s">OUTPUT_VARIABLE</span> <span class="s">CMAKE_C_COMPILER_VERSION</span><span class="p">)</span> + <span class="nb">if</span><span class="p">(</span><span class="s">CMAKE_C_COMPILER_VERSION</span> <span class="s">MATCHES</span> <span class="s2">".*4\\.[5-9].*"</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">PROMOD_GCC_45</span> <span class="s">true</span><span class="p">)</span> + <span class="nb">else</span><span class="p">()</span> + <span class="nb">set</span><span class="p">(</span><span class="s">PROMOD_GCC_45</span> <span class="s">false</span><span class="p">)</span> + <span class="nb">endif</span><span class="p">()</span> + <span class="nb">endif</span><span class="p">()</span> -<span class="nb">if</span> <span class="p">(</span><span class="s">OPTIMIZE</span><span class="p">)</span> - <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_BUILD_TYPE</span> <span class="s">Release</span><span class="p">)</span> - <span class="nb">set</span><span class="p">(</span><span class="s">_OPT</span> <span class="s">ON</span><span class="p">)</span> -<span class="nb">else</span><span class="p">()</span> - <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_BUILD_TYPE</span> <span class="s">Debug</span><span class="p">)</span> - <span class="nb">set</span><span class="p">(</span><span class="s">_OPT</span> <span class="s">OFF</span><span class="p">)</span> -<span class="nb">endif</span><span class="p">()</span> + <span class="nb">if</span> <span class="p">(</span><span class="s">OPTIMIZE</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_BUILD_TYPE</span> <span class="s">Release</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">_OPT</span> <span class="s">ON</span><span class="p">)</span> + <span class="nb">else</span><span class="p">()</span> + <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_BUILD_TYPE</span> <span class="s">Debug</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">_OPT</span> <span class="s">OFF</span><span class="p">)</span> + <span class="nb">endif</span><span class="p">()</span> -<span class="nb">setup_stage</span><span class="p">()</span> -<span class="nb">file</span><span class="p">(</span><span class="s">MAKE_DIRECTORY</span> <span class="o">${</span><span class="nv">STAGE_DIR</span><span class="o">}</span> - <span class="o">${</span><span class="nv">EXECUTABLE_OUTPUT_PATH</span><span class="o">}</span> - <span class="o">${</span><span class="nv">HEADER_STAGE_PATH</span><span class="o">}</span> - <span class="o">${</span><span class="nv">LIB_STAGE_PATH</span><span class="o">}</span> - <span class="o">${</span><span class="nv">LIBEXEC_STAGE_PATH</span><span class="o">}</span><span class="p">)</span> + <span class="nb">setup_stage</span><span class="p">()</span> + <span class="nb">file</span><span class="p">(</span><span class="s">MAKE_DIRECTORY</span> <span class="o">${</span><span class="nv">STAGE_DIR</span><span class="o">}</span> + <span class="o">${</span><span class="nv">EXECUTABLE_OUTPUT_PATH</span><span class="o">}</span> + <span class="o">${</span><span class="nv">HEADER_STAGE_PATH</span><span class="o">}</span> + <span class="o">${</span><span class="nv">LIB_STAGE_PATH</span><span class="o">}</span> + <span class="o">${</span><span class="nv">LIBEXEC_STAGE_PATH</span><span class="o">}</span><span class="p">)</span> -<span class="nb">setup_compiler_flags</span><span class="p">()</span> -<span class="nb">setup_boost</span><span class="p">()</span> + <span class="nb">setup_compiler_flags</span><span class="p">()</span> + <span class="nb">setup_boost</span><span class="p">()</span> -<span class="nb">find_package</span><span class="p">(</span><span class="s">Python</span> <span class="s">2.7</span> <span class="s">REQUIRED</span><span class="p">)</span> -<span class="nb">if</span><span class="p">(</span><span class="s">NOT</span> <span class="s">DISABLE_DOCUMENTATION</span><span class="p">)</span> - <span class="nb">find_package</span><span class="p">(</span><span class="s">Sphinx</span> <span class="o">${</span><span class="nv">PYTHON_VERSION</span><span class="o">}</span> <span class="s">REQUIRED</span><span class="p">)</span> - <span class="nb">set</span><span class="p">(</span><span class="s">PYTHON_DOC_URL</span> <span class="s2">"https://docs.python.org/${PYTHON_VERSION}"</span><span class="p">)</span> - <span class="c"># set this to the URL corresponding to the version of OST you are using</span> - <span class="nb">set</span><span class="p">(</span><span class="s">OST_DOC_URL</span> <span class="s2">"http://www.openstructure.org/docs/1.3"</span><span class="p">)</span> -<span class="nb">endif</span><span class="p">()</span> -<span class="nb">find_package</span><span class="p">(</span><span class="s">OPENSTRUCTURE</span> <span class="s">1.4</span> <span class="s">REQUIRED</span> - <span class="s">COMPONENTS</span> <span class="s">io</span> <span class="s">mol</span> <span class="s">seq</span> <span class="s">seq_alg</span> <span class="s">mol_alg</span> <span class="s">conop</span><span class="p">)</span> + <span class="nb">find_package</span><span class="p">(</span><span class="s">Python</span> <span class="s">2.7</span> <span class="s">REQUIRED</span><span class="p">)</span> + <span class="nb">if</span><span class="p">(</span><span class="s">NOT</span> <span class="s">DISABLE_DOCUMENTATION</span><span class="p">)</span> + <span class="nb">find_package</span><span class="p">(</span><span class="s">Sphinx</span> <span class="o">${</span><span class="nv">PYTHON_VERSION</span><span class="o">}</span> <span class="s">REQUIRED</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">PYTHON_DOC_URL</span> <span class="s2">"https://docs.python.org/${PYTHON_VERSION}"</span><span class="p">)</span> + <span class="c"># set this to the URL corresponding to the version of OST you are using</span> + <span class="nb">set</span><span class="p">(</span><span class="s">OST_DOC_URL</span> <span class="s2">"http://www.openstructure.org/docs/1.3"</span><span class="p">)</span> + <span class="nb">endif</span><span class="p">()</span> + <span class="nb">find_package</span><span class="p">(</span><span class="s">OPENSTRUCTURE</span> <span class="s">1.4</span> <span class="s">REQUIRED</span> + <span class="s">COMPONENTS</span> <span class="s">io</span> <span class="s">mol</span> <span class="s">seq</span> <span class="s">seq_alg</span> <span class="s">mol_alg</span> <span class="s">conop</span><span class="p">)</span> -<span class="nb">if</span> <span class="p">(</span><span class="s">CMAKE_COMPILER_IS_GNUCXX</span><span class="p">)</span> - <span class="c"># do not write back into cache, otherwise the compile command line gets</span> - <span class="c"># expanded with multiple -fno-strict-aliasing flags, triggering a complete</span> - <span class="c"># rebuild whenever cmake is run</span> - <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_CXX_FLAGS_RELEASE</span> <span class="s2">"${CMAKE_CXX_FLAGS_RELEASE} -fno-strict-aliasing"</span><span class="p">)</span> - <span class="nb">if</span><span class="p">(</span><span class="s2">"${CMAKE_CXX_COMPILER_VERSION}"</span> <span class="s">VERSION_GREATER</span> <span class="s2">"4.6"</span><span class="p">)</span> - <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_CXX_FLAGS</span> <span class="s2">"${CMAKE_CXX_FLAGS} -Wno-attributes"</span><span class="p">)</span> - <span class="nb">endif</span><span class="p">(</span><span class="s2">"${CMAKE_CXX_COMPILER_VERSION}"</span> <span class="s">VERSION_GREATER</span> <span class="s2">"4.6"</span><span class="p">)</span> -<span class="nb">endif</span><span class="p">()</span> + <span class="nb">if</span> <span class="p">(</span><span class="s">CMAKE_COMPILER_IS_GNUCXX</span><span class="p">)</span> + <span class="c"># do not write back into cache, otherwise the compile command line gets</span> + <span class="c"># expanded with multiple -fno-strict-aliasing flags, triggering a complete</span> + <span class="c"># rebuild whenever cmake is run</span> + <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_CXX_FLAGS_RELEASE</span> <span class="s2">"${CMAKE_CXX_FLAGS_RELEASE} -fno-strict-aliasing"</span><span class="p">)</span> + <span class="nb">if</span><span class="p">(</span><span class="s2">"${CMAKE_CXX_COMPILER_VERSION}"</span> <span class="s">VERSION_GREATER</span> <span class="s2">"4.6"</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">CMAKE_CXX_FLAGS</span> <span class="s2">"${CMAKE_CXX_FLAGS} -Wno-attributes"</span><span class="p">)</span> + <span class="nb">endif</span><span class="p">(</span><span class="s2">"${CMAKE_CXX_COMPILER_VERSION}"</span> <span class="s">VERSION_GREATER</span> <span class="s2">"4.6"</span><span class="p">)</span> + <span class="nb">endif</span><span class="p">()</span> -<span class="c"># basic environment</span> -<span class="nb">include_directories</span><span class="p">(</span><span class="o">${</span><span class="nv">Boost_INCLUDE_DIRS</span><span class="o">}</span> - <span class="o">${</span><span class="nv">OST_INCLUDE_DIR</span><span class="o">}</span><span class="p">)</span> + <span class="c"># basic environment</span> + <span class="nb">include_directories</span><span class="p">(</span><span class="o">${</span><span class="nv">Boost_INCLUDE_DIRS</span><span class="o">}</span> + <span class="o">${</span><span class="nv">OST_INCLUDE_DIR</span><span class="o">}</span><span class="p">)</span> -<span class="nb">set</span><span class="p">(</span><span class="s">FILES_TO_BE_REMOVED</span> <span class="o">${</span><span class="nv">PROJECT_BINARY_DIR</span><span class="o">}</span><span class="s">/stage</span><span class="p">)</span> -<span class="nb">set_directory_properties</span><span class="p">(</span><span class="s">PROPERTIES</span> <span class="s">ADDITIONAL_MAKE_CLEAN_FILES</span> - <span class="s2">"${FILES_TO_BE_REMOVED}"</span><span class="p">)</span> + <span class="nb">set</span><span class="p">(</span><span class="s">FILES_TO_BE_REMOVED</span> <span class="o">${</span><span class="nv">PROJECT_BINARY_DIR</span><span class="o">}</span><span class="s">/stage</span><span class="p">)</span> + <span class="nb">set_directory_properties</span><span class="p">(</span><span class="s">PROPERTIES</span> <span class="s">ADDITIONAL_MAKE_CLEAN_FILES</span> + <span class="s2">"${FILES_TO_BE_REMOVED}"</span><span class="p">)</span> -<span class="c">## sub dirs to be recognised by CMake</span> -<span class="c">## e.g. add_subdirectory(src), subdirs have their own CMakeLists.txt</span> -<span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">config</span><span class="p">)</span> -<span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">core</span><span class="p">)</span> -<span class="hll"><span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">sidechains</span><span class="p">)</span> -</span><span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">scripts</span><span class="p">)</span> -<span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">actions</span><span class="p">)</span> -<span class="nb">if</span><span class="p">(</span><span class="s">NOT</span> <span class="s">DISABLE_DOCUMENTATION</span><span class="p">)</span> - <span class="nb">add_changelog_to_doc</span><span class="p">(</span><span class="s">FILE</span> <span class="s2">"${CMAKE_CURRENT_SOURCE_DIR}/CHANGELOG"</span><span class="p">)</span> - <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">doc</span><span class="p">)</span> -<span class="nb">endif</span><span class="p">()</span> + <span class="c">## sub dirs to be recognised by CMake</span> + <span class="c">## e.g. add_subdirectory(src), subdirs have their own CMakeLists.txt</span> + <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">config</span><span class="p">)</span> + <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">core</span><span class="p">)</span> +<span class="hll"> <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">sidechains</span><span class="p">)</span> +</span> <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">scripts</span><span class="p">)</span> + <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">actions</span><span class="p">)</span> + <span class="nb">if</span><span class="p">(</span><span class="s">NOT</span> <span class="s">DISABLE_DOCUMENTATION</span><span class="p">)</span> + <span class="nb">add_changelog_to_doc</span><span class="p">(</span><span class="s">FILE</span> <span class="s2">"${CMAKE_CURRENT_SOURCE_DIR}/CHANGELOG"</span><span class="p">)</span> + <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">doc</span><span class="p">)</span> + <span class="nb">endif</span><span class="p">()</span> -<span class="c">## report setup</span> -<span class="nb">message</span><span class="p">(</span><span class="s">STATUS</span> <span class="s2">"PROMOD3 will be built with the following options:\n"</span> - <span class="s2">" OpenStructure (-DOST_ROOT) : ${OST_ROOT}\n"</span> - <span class="s2">" Optimized (-DOPTIMIZE) : ${_OPT}\n"</span> - <span class="s2">" Python : ${PYTHON_BINARY}\n"</span><span class="p">)</span> + <span class="c">## report setup</span> + <span class="nb">message</span><span class="p">(</span><span class="s">STATUS</span> <span class="s2">"PROMOD3 will be built with the following options:\n"</span> + <span class="s2">" OpenStructure (-DOST_ROOT) : ${OST_ROOT}\n"</span> + <span class="s2">" Optimized (-DOPTIMIZE) : ${_OPT}\n"</span> + <span class="s2">" Python : ${PYTHON_BINARY}\n"</span><span class="p">)</span> </pre></div> </td></tr></table></div> <p>All that needs to be done for CMake to recognise your module is adding its @@ -571,6 +570,61 @@ a new configuration script. The following example assumes Fedora 19.</p> </div> <p>From this point, <strong class="command">make</strong> should work and you could start adding your files to the repository using <tt class="docutils literal"><span class="pre">git</span> <span class="pre">add</span></tt>.</p> +<p>Up to now, we did not cover the <tt class="file docutils literal"><span class="pre">tests</span></tt> branch of a new module. But its +good practice to develop new functionality along tests and that right from the +beginning. At some point, new code needs testing anyway to see if it does what +it should, so just do this by writing unit tests. Test sources are stored in +files with a prefix <tt class="file docutils literal"><span class="pre">test_</span></tt> and usually come per submodule instead of +sporting a single monolithic <tt class="file docutils literal"><span class="pre">test_sidechains.py</span></tt>.</p> +<p>Python code is evaluated using its own +<a class="reference external" href="https://docs.python.org/2.7/library/unittest.html">unit testing framework</a> with a little help +from <a class="reference external" href="http://www.OpenStructure.org">OST</a>. The basic scheme is to import your module, subclass +<a class="reference external" href="https://docs.python.org/2.7/library/unittest.html#unittest.TestCase" title="(in Python v2.7)"><tt class="xref py py-class docutils literal"><span class="pre">unittest.TestCase</span></tt></a> and make the whole file runnable as script using the +most common <a class="reference external" href="https://docs.python.org/2.7/library/__main__.html"><tt class="xref py py-attr docutils literal"><span class="pre">__name__</span></tt></a> attribute. A file <tt class="file docutils literal"><span class="pre">tests/test_something.py</span></tt> could +look like this, carrying a single test case:</p> +<div class="highlight-python"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10</pre></div></td><td class="code"><div class="highlight"><pre> <span class="kn">import</span> <span class="nn">unittest</span> + <span class="kn">from</span> <span class="nn">promod3.sidechains</span> <span class="kn">import</span> <span class="n">something</span> + + <span class="k">class</span> <span class="nc">SomethingTests</span><span class="p">(</span><span class="n">unittest</span><span class="o">.</span><span class="n">TestCase</span><span class="p">):</span> + <span class="k">def</span> <span class="nf">testFileExistsFalse</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="bp">self</span><span class="o">.</span><span class="n">assertEquals</span><span class="p">(</span><span class="n">something</span><span class="o">.</span><span class="n">Else</span><span class="p">(),</span> <span class="mi">1</span><span class="p">)</span> + + <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">"__main__"</span><span class="p">:</span> + <span class="kn">from</span> <span class="nn">ost</span> <span class="kn">import</span> <span class="n">testutils</span> + <span class="n">testutils</span><span class="o">.</span><span class="n">RunTests</span><span class="p">()</span> +</pre></div> +</td></tr></table></div> +<p>To hook up your tests with <tt class="docutils literal"><span class="pre">make</span> <span class="pre">codetest</span></tt> (and to create a +<tt class="docutils literal"><span class="pre">test_something.py_run</span></tt> target), everything has to be introduced to CMake. +First, tell CMake to search <tt class="file docutils literal"><span class="pre">tests</span></tt> for a <tt class="file docutils literal"><span class="pre">CMakeLists.txt</span></tt> file +by extending the list of sub-directories in <tt class="file docutils literal"><span class="pre">sidechains/CMakeLists.txt</span></tt>:</p> +<div class="highlight-cmake"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1 +2 +3</pre></div></td><td class="code"><div class="highlight"><pre> <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">pymod</span><span class="p">)</span> + <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">doc</span><span class="p">)</span> + <span class="nb">add_subdirectory</span><span class="p">(</span><span class="s">tests</span><span class="p">)</span> +</pre></div> +</td></tr></table></div> +<p>Then fill <tt class="file docutils literal"><span class="pre">sidechains/tests/CMakeLists.txt</span></tt> with your new test script and +<tt class="docutils literal"><span class="pre">make</span></tt> will recognise the changes next time it is run and fix the rest for +you.</p> +<div class="highlight-cmake"><pre> set(SIDECHAINS_UNIT_TESTS + test_something.py + ) + + promod3_unittest(MODULE sidechains SOURCES "${SIDECHAINS_UNIT_TESTS}")</pre> +</div> +<p>Now tests should be available by <tt class="docutils literal"><span class="pre">make</span> <span class="pre">check</span></tt>, <tt class="docutils literal"><span class="pre">make</span> <span class="pre">codetest</span></tt> and +<tt class="docutils literal"><span class="pre">make</span> <span class="pre">test_something.py_run</span></tt>.</p> </div> </div> @@ -643,7 +697,7 @@ files to the repository using <tt class="docutils literal"><span class="pre">git </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/core/argcheck.html b/doc/html/core/argcheck.html index 1b5d174d8f2ddffebb4204680e5e81b8957a0521..c6ecdcaaa615c7992598c08c7e09404d348d0352 100644 --- a/doc/html/core/argcheck.html +++ b/doc/html/core/argcheck.html @@ -217,7 +217,7 @@ shell. <tt class="docutils literal"><span class="pre">0</span></tt> is tradition </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 13:39, 2014. + Last updated on Jun 14 18:21, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/core/index.html b/doc/html/core/index.html index 14636e68b6d3287570b9f6896a115ee65475c9bb..1fe5181b6d6cda4b826887796703fdb8a423d5e8 100644 --- a/doc/html/core/index.html +++ b/doc/html/core/index.html @@ -123,7 +123,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 13:39, 2014. + Last updated on Jun 14 18:21, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/developers.html b/doc/html/developers.html index 58fcbad03d41bb38b379c61bee613e1199869c6f..201c20ec229b9544ad45897ccb1772344169f485 100644 --- a/doc/html/developers.html +++ b/doc/html/developers.html @@ -139,7 +139,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/genindex.html b/doc/html/genindex.html index ec5e6d559ac9eda6398e3ba29df95f5e9de619d3..2ca5e3beac3786d5ff7f9971de7546cd2ae415e5 100644 --- a/doc/html/genindex.html +++ b/doc/html/genindex.html @@ -308,7 +308,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/index.html b/doc/html/index.html index 9ff48fa481b166eebb839b9572531746d5476eca..97396da1ba57c33d8e8e04bfa1a107fb3885d51c 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -134,7 +134,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/meld/index.html b/doc/html/meld/index.html index 99d458aac43c2b1120f9a4316f0f11ef9a4f3f09..68e4bce984ff3fabd77867ce5392a53e4248c3e4 100644 --- a/doc/html/meld/index.html +++ b/doc/html/meld/index.html @@ -127,7 +127,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 13:39, 2014. + Last updated on Jun 14 18:21, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/meld/loop.html b/doc/html/meld/loop.html index 0c2db6ed37b75b55029348284503ded02a730ff9..e94d15777f4e5322ed88aaba824058b23ee8de17 100644 --- a/doc/html/meld/loop.html +++ b/doc/html/meld/loop.html @@ -338,7 +338,7 @@ extension of the gap.</p> </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 13:39, 2014. + Last updated on Jun 14 18:21, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/meld/rawmodel.html b/doc/html/meld/rawmodel.html index 1838d45abb78a9fad790227c95272082e928e7c3..b721bd82c916d6e5c2820b50428c5621a13d7079 100644 --- a/doc/html/meld/rawmodel.html +++ b/doc/html/meld/rawmodel.html @@ -221,7 +221,7 @@ missing or incomplete backbone coordinates in the template structure.</p> </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 13:39, 2014. + Last updated on Jun 14 18:21, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/py-modindex.html b/doc/html/py-modindex.html index c4ea1c8467e4804ea9ba47182cb319fa090ef1b1..5fdf3629560ddc601ea68faaeaf50e8c01fb0bea 100644 --- a/doc/html/py-modindex.html +++ b/doc/html/py-modindex.html @@ -113,7 +113,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/search.html b/doc/html/search.html index 88fa4ab3f67685c4a2cd853f97ff8a546ef341f5..e4cd620c17989bf229f51461d85841d842796376 100644 --- a/doc/html/search.html +++ b/doc/html/search.html @@ -99,7 +99,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 14:31, 2014. + Last updated on Jun 14 19:22, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body> diff --git a/doc/html/searchindex.js b/doc/html/searchindex.js index 30fd4ffdeac1b7bf9050732d2f18a16b22b291b7..fabc95463533a5787dd5b15f453f461e87b5c940 100644 --- a/doc/html/searchindex.js +++ b/doc/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{aln:6,all:[8,0,1,4,6],code:[8,0,4],forget:8,structuralgap:1,messi:4,skip:4,ost:[0,1,2,3,4,5,6,7,8,9,10],disable_document:[8,4],prefix:[4,0],concept:4,abil:4,follow:[4,6],middl:4,chain:[4,6],readabl:4,init:4,program:7,under:4,introduc:4,sourc:[8,0,4],everi:[4,6],string:0,fals:[4,0,1,6],internet:4,candid:1,worst:4,failur:[4,0],veri:[4,0],affect:4,tri:6,four:1,foo:4,magic:4,level:[8,4],did:[],list:[8,0,1,4,6],item:[4,6],fileextens:0,servic:4,dir:4,malici:4,promod_gcc_45:4,your_modul:4,direct:4,past:4,second:6,design:0,pass:4,minimis:[],acid:6,even:4,index:[4,5],what:[8,0,4],hide:4,sub:4,resembl:4,sum:1,invok:[8,4],access:1,delet:6,version:[8,4],"new":[4,1,6],boost:[0,1,2,3,4,5,6,7,8,9,10],method:1,meld:[],subtre:4,submodule1:4,honour:1,gener:4,never:4,here:[8,0,4,6],sphinx:[0,1,2,3,4,5,6,7,8,9,10],save:4,lib_stage_path:4,modif:6,"1ake":6,path:[8,0,4],modifi:[4,6,3],implicit:8,valu:0,wait:4,search:[8,5,4],executable_output_path:4,setup_boost:4,promod3_version_minor:4,doctest:[8,4],within:[8,4],action:4,implement:4,stage_dir:4,honor:6,chanc:4,argpars:0,spawn:4,via:4,extra:4,solut:4,modul:3,submodul:4,unix:4,api:[],instal:8,total:1,unit:[],highli:8,fed:4,from:[0,1,3,6,8,9,4],describ:0,would:[8,4],regist:4,two:4,next:4,everybodi:4,few:[8,4,1,6],live:4,call:[8,4],recommend:8,loadalign:6,checkout:4,tell:[4,0],tightli:4,more:[8,4,6],sort:1,chapter:4,peopl:4,relat:4,notic:4,warn:4,flag:[4,0],templat:6,particular:4,known:0,rare:4,hold:[1,6],cach:[8,4],must:4,py_run:4,hous:4,setup:[4,3],work:[8,4],histori:4,remain:6,can:[8,0,4,6],torsion_scor:1,purpos:4,root:4,fetch:[4,0],control:4,give:4,process:4,add_argu:0,indic:[],topic:4,candit:1,want:[8,4],backbonelist:1,hydrogen:6,packing_scor:1,alwai:4,gcc:4,cours:4,end:[8,0,1,4],thing:[8,4],rather:4,comfort:0,calpha_onli:6,how:[],sever:[8,4],verifi:0,config:4,updat:4,python_vers:4,attachview:6,entityhandl:[1,6],rebas:4,mess:4,clone:4,after:4,usabl:4,sortbyscor:1,befor:4,wrong:8,attent:4,mai:[4,6],multipl:4,data:4,grow:6,man:[8,4],"short":4,practic:4,third:4,mol_alg:4,sit:4,correspond:[4,1],stash:4,disabl:4,issu:[4,7],inform:6,"switch":4,maintain:4,environ:4,allow:4,order:1,origin:4,promod3_version_major:4,help:[8,4],over:[8,4,6],insight:4,increas:1,through:4,files_to_be_remov:4,gitignor:4,still:4,pointer:8,paramet:[0,1,6],output_vari:4,binari:4,fix:[4,0],selenium:6,structuralgaplist:6,carri:0,complex:4,onc:4,python_doc_url:4,therefor:4,easier:1,linkcheck:[8,4],them:4,good:4,"return":[0,1,6],thei:[4,1],python:[0,1,2,3,4,5,6,7,8,9,10],dai:0,exot:4,"break":4,conquer:4,clash_bb_scor:1,instead:[8,0,4],front:[8,0,4],now:[4,6],minimalist:6,cmake_cxx_flags_releas:4,libexec_stage_path:4,name:[4,0],rmsd:1,anyth:[8,4],separ:4,easili:4,achiev:4,each:4,debug:4,found:4,went:4,complet:[4,6],side:4,mean:[8,0],compil:4,parwis:6,cmake_module_path:4,test_sidechain:[],idea:[4,3],realli:[8,0,4],"static":4,"2b1":8,our:4,special:[8,4],out:[8,4],variabl:[8,4],shown:4,goe:[8,4],crucial:4,content:[4,5,10],reader:4,print:[8,6],got:8,exec_program:4,dive:4,integr:4,runtimeerror:[1,6],differ:[8,4],free:4,standard:[],headlin:4,reason:4,base:[0,6],put:[8,0,4],org:4,basi:4,could:[4,6],success:[0,1],keep:4,turn:[4,0],clash_sc_scor:1,place:4,think:4,first:[4,3],oper:4,softwar:4,major:4,suffix:0,obviou:4,feel:4,sidechains_pymod:4,number:[1,6],yourself:[8,4],restrict:4,date:4,alreadi:4,done:4,messag:[4,0],blank:4,stabl:4,miss:[0,1,6],straight:4,exit_statu:0,given:[0,1],script:[8,0,4],top:[8,4],perfectli:4,mkdir:4,system:[8,4,3],least:[8,4],stack:4,attach:6,stori:4,master:4,too:4,termin:0,recent:4,"final":[4,6],store:[4,1,6],shell:[8,0],option:[8,0,4],tool:0,copi:[4,6],restrict_chain:6,openstructur:[0,1,2,3,4,5,6,7,8,9,10],pars:0,boost_include_dir:4,mostli:4,rst:4,conop:4,than:4,kind:4,setup_compiler_flag:4,whenev:4,provid:[8,4],seamlessli:4,tree:4,unrecognis:0,project:4,find_packag:4,reus:6,str:[0,6],were:4,posit:[0,1],toward:4,initi:3,builder:8,python_binari:4,sometim:4,mind:4,argument:[],packag:4,manner:4,have:[8,4,1,6],need:[8,0,4],fasta:6,tidi:4,cmake_current_source_dir:4,optimis:4,rmsdto:1,imagin:4,probabl:[8,4],built:4,advic:4,alias:4,diverg:4,also:[8,0,4,6],exampl:[8,4,6],take:[4,6],which:[4,6,7],thoroughli:4,noth:4,singl:[4,6],"_opt":4,sure:4,clash:1,track:0,forg:4,compress:0,most:[4,0,6],hotfix:4,everyth:4,renam:3,url:4,doc:[8,4],later:4,cover:[4,0,7],doe:[4,0,6],ext:0,declar:4,clean:[8,4],review:4,cmakelist:[8,4],show:4,dbg:4,bring:4,add_doc_sourc:4,fine:4,find:4,involv:4,current:4,onli:[4,0,6],locat:8,explain:4,configur:[8,4],activ:4,figur:4,should:[4,0],header_stage_path:4,suppos:[4,1],folder:4,move:4,hit:4,unus:4,variou:8,get:[8,4],cannot:4,loadpdb:6,report:[4,6],toolbox:4,requir:[8,4,1],add_changelog_to_doc:4,enabl:0,coord:1,gather:[4,7],"default":[8,4],common:0,contain:[8,0,4,6,9],python_root:8,where:4,remov:8,view:4,set:[8,0,1,4,6],seq:4,allatom_scor:1,frame:4,around:4,ost_include_dir:4,see:4,temporarili:4,result:6,arg:4,fail:[4,1],reserv:0,awar:4,statu:4,detect:0,extend:4,someth:4,version_great:4,enumer:4,label:4,state:8,score:1,subdir:4,simplest:4,awai:4,entiti:[4,1],approach:4,attribut:4,accord:4,parent:6,sole:4,extens:[0,1],test_your_modul:4,solv:4,come:[4,0],popul:4,cmake_cxx_compiler_vers:4,howev:1,disable_doctest:[8,4],promod3_version_patch:4,tutori:4,grain:4,fno:4,let:4,whole:[4,6],pdb:[0,6],comment:4,sidechains_rst:4,set_directory_properti:4,point:[4,1],cxx:4,overview:4,argumentpars:0,pop:4,except:4,residu:[1,6],header:4,littl:4,test_submodule1:4,assum:4,torsion:1,quit:4,template_structur:6,coupl:4,rebuild:[8,4],three:4,been:4,sinc:[4,0],compon:4,trigger:4,besid:8,treat:[4,6],basic:[8,4,6],txt:[8,4],ost_root:[8,4],addit:[4,0],mmcif:0,tini:4,quickli:4,life:[4,1],convert:6,gap:[1,6],coordin:[],togeth:4,els:4,fileexist:0,educ:4,those:[8,4],"case":4,cmake_c_compiler_vers:4,look:[4,0],raw:[],align:6,properti:4,formatt:4,calcul:1,boost_root:8,abov:4,error:0,dost_root:[8,4],loop:[],pack:1,methionin:6,bin:4,smng:3,helper:1,sidechain:[4,1,6],henc:4,non:4,itself:4,clutter:4,conf:[8,4],protein:[9,6],dedic:[8,4],"__init__":4,reviv:4,develop:[],fedora:4,etc:4,author:4,parti:4,belong:4,savepdb:6,same:[8,1],"while":[4,0],member:[4,6],fragment:1,drawback:4,admir:4,document:[],conflict:4,higher:8,http:4,optim:4,bienchen:4,make_directori:4,hand:8,driven:4,rais:[1,6],disable_linkcheck:[8,4],user:[],extern:4,respons:4,tradition:0,expand:4,codetest:4,off:[4,6],parse_arg:0,pymod:4,nevertheless:4,macro:4,markup:4,well:[8,4,1,6],without:[0,6],branchnam:4,thi:[0,1,6,7,8,9,4],endif:4,gzip:0,model:[],loss:4,spend:4,usual:[8,4],cmake_support:4,clash_scor:1,just:[8,4],entri:4,mol:4,reduced_scor:1,obtain:6,rest:[0,1,2,3,4,5,6,7,8,9,10],product:4,touch:4,web:8,loopcandid:1,restructuredtext:[0,1,2,3,4,5,6,7,8,9,10],makefil:[8,4],rawmodelingresult:6,param:1,add:[4,1],densiti:1,input:0,subsequ:6,match:[4,6],opt:0,advis:4,format:4,handl:6,specimen:0,setup_stag:4,piec:4,source2:4,source1:4,elabor:4,bit:[8,4],walk:4,cmake_compiler_is_gnucxx:4,mod:4,insert:[1,6],like:[4,6],lost:4,incred:6,manual:[8,4],html:[8,4,3],test_awesome_featur:4,"boolean":0,either:[4,6],output:0,page:[8,5,4],www:4,right:[8,4],often:0,some:[4,0],begin:4,resolv:4,intern:4,proper:4,thu:0,smallish:[8,4],lead:0,avoid:4,per:[4,7],exit:0,select:6,recognis:4,devot:7,condit:4,amino:6,core:[],plu:4,run:[8,4],cmake_source_dir:4,backbon:[1,6],step:4,repositori:[4,3],cmake_minimum_requir:4,intervent:4,trustworthi:4,src:4,about:[4,6],actual:[4,1],materi:4,manag:4,coars:4,commit:4,ost_doc_url:4,produc:8,own:[],"float":1,automat:[4,0],due:[1,6],promod3_version_str:4,empti:4,cmake_cxx_flag:4,strip:6,announc:4,your:[],merg:4,git:[],log:4,wai:[8,4],support:0,renumb:6,custom:4,avail:[8,4],start:[],sortbycorrel:1,much:[4,6],interfac:4,includ:[4,0,3],lot:[4,0],suit:4,forward:4,strict:4,far:[],unfortun:4,"function":[],headach:4,enough:4,tupl:0,buildrawmodel:6,wno:4,back:4,link:[8,4],atom:[1,6],don:[8,4],inlin:4,"true":[4,0,1,6],bug:4,pull:4,tripl:0,immedi:4,consist:4,possibl:[4,6],whether:0,type:[0,1,6],insertinto:1,displai:0,seq_alg:4,below:4,otherwis:4,problem:4,similar:8,featur:4,creat:[8,4],"int":0,certain:8,utilis:[4,0],fellow:4,incomplet:6,exist:[4,0,1],file:[],deuterium:6,check:[8,0,4],fill:4,echo:4,again:[8,4],calpha:6,when:[4,6],detail:[4,6],other:[8,4,6],bool:[0,1],seem:4,test:[],you:[8,0,4],phosphoserin:6,correl:1,bb_list:1,toentiti:1,additional_make_clean_fil:4,determin:0,sequenc:[9,1,6],cmake_build_typ:4,add_subdirectori:4,briefli:4,consid:4,homolog:7,doptim:4,fatal_error:4,stai:4,reduc:1,peptid:[1,6],algorithm:6,project_binary_dir:4,directori:[],descript:4,pseudo:6,rule:4,ignor:6,time:[4,6],push:4,include_directori:4},objtypes:{"0":"py:module","1":"py:function","2":"py:method","3":"py:attribute","4":"py:class"},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","class","Python class"]},filenames:["core/argcheck","meld/loop","users","changelog","contributing","index","meld/rawmodel","core/index","buildsystem","meld/index","developers"],titles:["<tt class=\"docutils literal\"><span class=\"pre\">argcheck</span></tt> - Standard tests for command line arguments","Loop Modeling","Documentation For Users","Changelog","Contributing","Welcome to ProMod3’s documentation!","Raw Coordinate Modeling","<tt class=\"docutils literal\"><span class=\"pre\">core</span></tt> - ProMod3 core functionality","Building ProMod3","<tt class=\"docutils literal\"><span class=\"pre\">meld</span></tt> - Coordinate modeling","Documentation For Developes"],objects:{"promod3.core.argcheck":{FileExtension:[0,1,1,""],FileExists:[0,1,1,""]},"sm.meld.LoopCandidate":{correl:[1,3,1,""],clash_score:[1,3,1,""],allatom_score:[1,3,1,""],score:[1,3,1,""],reduced_score:[1,3,1,""],torsion_score:[1,3,1,""],InsertInto:[1,2,1,""],gap:[1,3,1,""],clash_sc_score:[1,3,1,""],ToEntity:[1,2,1,""],clash_bb_score:[1,3,1,""],coords:[1,3,1,""],packing_score:[1,3,1,""],RmsdTo:[1,2,1,""]},"sm.meld":{LoopCandidate:[1,4,1,""],LoopCandidates:[1,4,1,""],BuildRawModel:[6,1,1,""],RawModelingResult:[6,4,1,""]},"sm.meld.RawModelingResult":{model:[6,3,1,""],gaps:[6,3,1,""]},"sm.meld.LoopCandidates":{SortByScore:[1,2,1,""],model:[1,3,1,""],SortByCorrel:[1,2,1,""],Add:[1,2,1,""]},promod3:{core:[7,0,1,""],meld:[9,0,1,""]}},titleterms:{pre:[0,7,9],own:4,modul:4,argument:0,indic:5,raw:6,api:[1,6],file:0,tabl:5,chang:3,your:4,unit:4,git:4,cmake:[8,4],welcom:5,start:4,make:8,write:4,how:4,build:8,branch:4,test:[4,0],"import":8,document:[4,5,10,2],promod3:[8,5,7],meld:9,"function":7,core:7,liter:[0,7,9],argcheck:0,contribut:4,standard:0,coordin:[9,6],user:2,releas:3,develop:10,line:0,"class":[0,7,9],stage:4,target:8,changelog:3,directori:4,docutil:[0,7,9],introduct:[0,6],structur:4,command:0,span:[0,7,9],model:[9,1,6],loop:1,depend:8}}) \ No newline at end of file +Search.setIndex({envversion:42,terms:{aln:6,cmakelist:[8,10],all:[8,0,1,10,6],code:[8,0,10],forget:8,chain:[10,6],messi:10,skip:10,sidechains_unit_test:10,ost:[0,1,2,3,4,5,6,7,8,9,10],disable_document:[8,10],prefix:[10,0],concept:10,subclass:10,abil:10,follow:[10,6],middl:10,structuralgap:1,readabl:10,init:10,program:7,those:[8,10],under:10,introduc:10,sourc:[8,0,10],everi:[10,6],string:0,fals:[10,0,1,6],internet:10,candid:1,worst:10,failur:[10,0],veri:[10,0],affect:10,runnabl:10,tri:6,four:1,foo:[],magic:10,level:[8,10],did:10,list:[8,0,1,10,6],assertequ:10,item:[10,6],fileextens:0,align:6,dir:10,malici:10,promod_gcc_45:10,your_modul:10,direct:10,past:10,second:6,design:0,pass:10,acid:6,even:10,index:[10,5],what:[8,0,10],hide:10,sub:10,resembl:10,sum:1,calcul:1,find:10,current:10,delet:6,version:[8,10],"new":[10,1,6],boost:[0,1,2,3,4,5,6,7,8,9,10],method:1,meld:[],subtre:10,submodule1:10,honour:1,gener:10,never:10,here:[8,0,10,6],sphinx:[0,1,2,3,4,5,6,7,8,9,10],save:10,lib_stage_path:10,let:10,set_directory_properti:10,path:[8,0,10],along:10,modifi:[10,6,4],implicit:8,valu:0,wait:10,test_someth:10,search:[8,5,10],executable_output_path:10,setup_boost:10,promod3_version_minor:10,doctest:[8,10],within:[8,10],action:10,implement:10,stage_dir:10,honor:6,chanc:10,argpars:0,spawn:10,via:10,extra:10,activ:10,modul:[],submodul:10,unix:10,api:[],instal:8,total:1,unit:[],highli:8,fed:10,from:[0,1,4,6,8,9,10],describ:0,would:[8,10],regist:10,two:10,next:10,everybodi:10,few:[8,10,1,6],live:10,call:[8,10],recommend:8,loadalign:6,checkout:10,tell:[10,0],tightli:10,more:[8,10,6],sort:1,chapter:10,peopl:10,relat:10,notic:10,warn:10,flag:[10,0],include_directori:10,particular:10,known:0,actual:[10,1],hold:[1,6],cach:[8,10],must:10,py_run:10,hous:10,setup:[10,4],work:[8,10],histori:10,remain:6,can:[8,0,10,6],torsion_scor:1,purpos:10,root:10,fetch:[10,0],def:10,control:10,give:10,process:10,add_argu:0,indic:[],topic:10,candit:1,want:[8,10],backbonelist:1,hydrogen:6,packing_scor:1,alwai:10,gcc:10,cours:10,end:[8,0,1,10],thing:[8,10],rather:10,comfort:0,sever:[8,10],verifi:0,config:10,updat:10,python_vers:10,product:10,entityhandl:[1,6],rebas:10,mess:10,clone:10,after:10,usabl:10,sortbyscor:1,befor:10,wrong:8,attent:10,mai:[10,6],multipl:10,data:10,grow:6,man:[8,10],"short":10,practic:10,third:10,ost_doc_url:10,sit:10,correspond:[10,1],stash:10,produc:8,issu:[10,7],alias:10,"switch":10,maintain:10,environ:10,allow:10,order:1,origin:10,promod3_version_major:10,help:[8,10],over:[8,10,6],insight:10,report:[10,6],through:10,same:[8,1],gitignor:10,still:10,pointer:8,entiti:[10,1],output_vari:10,binari:10,fix:[10,0],selenium:6,structuralgaplist:6,carri:[10,0],drawback:10,onc:10,python_doc_url:10,therefor:10,easier:1,linkcheck:[8,10],them:10,good:10,"return":[0,1,6],thei:[10,1],python:[0,1,2,3,4,5,6,7,8,9,10],dai:0,exot:10,docu:[],"break":10,framework:10,conquer:10,clash_bb_scor:1,instead:[8,0,10],front:[8,0,10],now:[10,6],minimalist:6,cmake_cxx_flags_releas:10,libexec_stage_path:10,name:[10,0],rmsd:1,anyth:[8,10],separ:10,easili:10,achiev:10,each:10,debug:10,found:10,went:10,complet:[10,6],side:10,mean:[8,0],compil:10,monolith:10,parwis:6,cmake_module_path:10,test_sidechain:10,idea:[10,4],realli:[8,0,10],runtest:10,"static":10,"2b1":8,our:10,special:[8,10],out:[8,10],variabl:[8,10],shown:10,goe:[8,10],promod3_unittest:10,crucial:10,content:[10,5,2],reader:10,print:[8,6],got:8,exec_program:10,dive:10,integr:10,insid:[],runtimeerror:[1,6],differ:[8,10],free:10,standard:[],headlin:10,reason:10,base:[0,6],put:[8,0,10],org:10,basi:10,could:[10,6],insert:[1,6],keep:10,turn:[10,0],clash_sc_scor:1,place:10,think:10,first:[10,4],oper:10,softwar:10,major:10,suffix:0,obviou:10,feel:10,sidechains_pymod:10,number:[1,6],yourself:[8,10],restrict:10,date:10,alreadi:10,done:10,messag:[10,0],blank:10,stabl:10,miss:[0,1,6],straight:10,exit_statu:0,given:[0,1],script:[8,0,10],top:[8,10],perfectli:10,mkdir:10,system:[8,10,4],least:[8,10],stack:10,attach:6,stori:10,master:10,too:10,termin:0,scheme:10,"final":[10,6],store:[10,1,6],includ:[10,0,4],shell:[8,0],option:[8,0,10],tool:0,copi:[10,6],restrict_chain:6,openstructur:[0,1,2,3,4,5,6,7,8,9,10],pars:0,boost_include_dir:10,mostli:10,rst:10,off:[10,6],than:10,kind:10,setup_compiler_flag:10,whenev:10,provid:[8,10],seamlessli:10,tree:10,unrecognis:0,project:10,nevertheless:10,reus:6,str:[0,6],were:10,posit:[0,1],toward:10,initi:4,builder:8,python_binari:10,sometim:10,mind:10,argument:[],packag:10,manner:10,have:[8,10,1,6],"__main__":10,need:[8,0,10],fasta:6,tidi:10,cmake_current_source_dir:10,optimis:10,rmsdto:1,imagin:10,probabl:[8,10],built:10,advic:10,inform:6,diverg:10,self:10,dedic:[8,10],lost:10,also:[8,0,10,6],exampl:[8,10,6],take:[10,6],which:[10,6,7],thoroughli:10,noth:10,singl:[10,6],"_opt":10,sure:10,clash:1,track:0,forg:10,compress:0,somethingtest:10,most:[10,0,6],hotfix:10,everyth:10,renam:4,bug:10,url:10,doc:[8,10],later:10,cover:[10,0,7],doe:[10,0,6],ext:0,declar:10,clean:[8,10],review:10,py_doc:[],show:10,dbg:10,attachview:6,bring:10,cmake_support:10,fine:10,anywai:10,involv:10,access:1,onli:[10,0,6],locat:8,explain:10,configur:[8,10],solut:10,figur:10,should:[10,0],header_stage_path:10,suppos:[10,1],templat:6,folder:10,move:10,hit:10,unus:10,variou:8,get:[8,10],cannot:10,loadpdb:6,increas:1,toolbox:10,requir:[8,10,1],add_changelog_to_doc:10,enabl:0,coord:1,"default":[8,10],common:[10,0],contain:[8,0,10,6,9],python_root:8,where:10,remov:8,view:10,set:[8,0,1,10,6],seq:10,allatom_scor:1,sth:[],frame:10,ost_include_dir:10,see:10,temporarili:10,result:6,arg:10,testcas:10,reserv:0,sport:10,nameattr:[],awar:10,statu:10,detect:0,extend:10,someth:10,version_great:10,enumer:10,label:10,state:8,score:1,subdir:10,simplest:10,awai:10,paramet:[0,1,6],approach:10,attribut:10,accord:10,parent:6,sole:10,cmake_cxx_compiler_vers:10,test_your_modul:10,recent:10,solv:10,come:[10,0],popul:10,fail:[10,1],extens:[0,1],howev:1,disable_doctest:[8,10],promod3_version_patch:10,tutori:10,grain:10,fno:10,modif:6,whole:[10,6],pdb:[0,6],comment:10,sidechains_rst:10,"1ake":6,point:[10,1],cxx:10,overview:10,unittest:10,argumentpars:0,pop:10,walk:10,residu:[1,6],header:10,featur:10,littl:10,test_submodule1:10,assum:10,torsion:1,quit:10,template_structur:6,evalu:10,coupl:10,rebuild:[8,10],three:10,been:10,sinc:[10,0],compon:10,trigger:10,besid:8,treat:[10,6],basic:[8,10,6],txt:[8,10],ost_root:[8,10],addit:[10,0],seq_alg:10,tini:10,quickli:10,life:[10,1],convert:6,gap:[1,6],coordin:[],togeth:10,els:10,fileexist:0,educ:10,pymod_unittest:[],"case":10,ugli:[],cmake_c_compiler_vers:10,look:[10,0],raw:[],testfileexistsfals:10,servic:10,properti:10,formatt:10,defin:[],invok:[8,10],boost_root:8,abov:10,error:0,dost_root:[8,10],loop:[],pack:1,methionin:6,bin:10,smng:4,helper:1,sidechain:[10,1,6],henc:10,non:10,itself:10,clutter:10,conf:[8,10],protein:[9,6],calpha_onli:6,"__init__":10,reviv:10,develop:[],fedora:10,etc:10,parti:10,belong:10,savepdb:6,files_to_be_remov:10,"while":[10,0],member:[10,6],fragment:1,complex:10,advis:10,admir:10,document:[],conflict:10,higher:8,http:10,optim:10,bienchen:10,make_directori:10,hand:8,driven:10,rais:[1,6],disable_linkcheck:[8,10],user:[],"_nameattr":[],extern:10,respons:10,tradition:0,expand:10,codetest:10,runabl:[],conop:10,pymod:10,find_packag:10,macro:10,markup:10,well:[8,10,1,6],without:[0,6],command:[],branchnam:10,thi:[0,1,6,7,8,9,10],endif:10,gzip:0,model:[],spend:10,usual:[8,10],add_doc_sourc:10,clash_scor:1,just:[8,10],entri:10,elabor:10,reduced_scor:1,obtain:6,rest:[0,1,2,3,4,5,6,7,8,9,10],touch:10,bit:[8,10],web:8,loopcandid:1,restructuredtext:[0,1,2,3,4,5,6,7,8,9,10],makefil:[8,10],except:10,param:1,add:[10,1],densiti:1,input:0,subsequ:6,match:[10,6],opt:0,around:10,format:10,handl:6,specimen:0,piec:10,source2:10,source1:10,mol:10,extlink:[],you:[8,0,10],mod:10,loss:10,like:[10,6],success:[0,1],incred:6,manual:[8,10],html:[8,10,4],test_:10,test_awesome_featur:10,"boolean":0,either:[10,6],output:0,hook:10,page:[8,5,10],www:10,right:[8,10],often:0,some:[10,0],begin:10,resolv:10,intern:10,proper:10,librari:[],thu:0,smallish:[8,10],lead:0,avoid:10,per:[10,7],exit:0,select:6,recognis:10,devot:7,condit:10,amino:6,core:[],plu:10,run:[8,10],cmake_source_dir:10,backbon:[1,6],step:10,repositori:[10,4],"__name__":10,add_subdirectori:10,intervent:10,mmcif:0,trustworthi:10,src:10,about:[10,6],rare:10,materi:10,manag:10,coars:10,commit:10,mol_alg:10,disabl:10,"float":1,automat:[10,0],due:[1,6],promod3_version_str:10,empti:10,cmake_cxx_flag:10,strip:6,announc:10,merg:10,git:[],log:10,wai:[8,10],support:0,renumb:6,custom:10,avail:[8,10],strict:10,sortbycorrel:1,much:[10,6],interfac:10,author:10,lot:[10,0],suit:10,forward:10,parse_arg:0,unfortun:10,"function":[],headach:10,enough:10,tupl:0,buildrawmodel:6,wno:10,back:10,link:[8,10],atom:[1,6],don:[8,10],line:[],inlin:10,"true":[10,0,1,6],setup_stag:10,pull:10,tripl:0,immedi:10,attr:[],consist:10,possibl:[10,6],whether:0,type:[0,1,6],insertinto:1,displai:0,below:10,otherwis:10,problem:10,similar:8,testutil:10,gather:[10,7],creat:[8,10],"int":0,certain:8,utilis:[10,0],fellow:10,incomplet:6,exist:[10,0,1],file:[],deuterium:6,check:[8,0,10],fill:10,echo:10,again:[8,10],calpha:6,when:[10,6],detail:[10,6],other:[8,10,6],bool:[0,1],seem:10,test:[],cmake_compiler_is_gnucxx:10,phosphoserin:6,correl:1,bb_list:1,toentiti:1,additional_make_clean_fil:10,determin:0,rawmodelingresult:6,sequenc:[9,1,6],cmake_build_typ:10,cmake_minimum_requir:10,briefli:10,consid:10,homolog:7,doptim:10,fatal_error:10,stai:10,reduc:1,peptid:[1,6],algorithm:6,project_binary_dir:10,directori:[],descript:10,pseudo:6,rule:10,ost_:[],ignor:6,time:[10,6],push:10},objtypes:{"0":"py:module","1":"py:function","2":"py:method","3":"py:attribute","4":"py:class"},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","class","Python class"]},filenames:["core/argcheck","meld/loop","developers","users","changelog","index","meld/rawmodel","core/index","buildsystem","meld/index","contributing"],titles:["<tt class=\"docutils literal\"><span class=\"pre\">argcheck</span></tt> - Standard tests for command line arguments","Loop Modeling","Documentation For Developes","Documentation For Users","Changelog","Welcome to ProMod3’s documentation!","Raw Coordinate Modeling","<tt class=\"docutils literal\"><span class=\"pre\">core</span></tt> - ProMod3 core functionality","Building ProMod3","<tt class=\"docutils literal\"><span class=\"pre\">meld</span></tt> - Coordinate modeling","Contributing"],objects:{"promod3.core.argcheck":{FileExtension:[0,1,1,""],FileExists:[0,1,1,""]},"sm.meld.LoopCandidate":{correl:[1,3,1,""],clash_score:[1,3,1,""],allatom_score:[1,3,1,""],score:[1,3,1,""],reduced_score:[1,3,1,""],torsion_score:[1,3,1,""],InsertInto:[1,2,1,""],gap:[1,3,1,""],clash_sc_score:[1,3,1,""],ToEntity:[1,2,1,""],clash_bb_score:[1,3,1,""],coords:[1,3,1,""],packing_score:[1,3,1,""],RmsdTo:[1,2,1,""]},"sm.meld":{LoopCandidate:[1,4,1,""],LoopCandidates:[1,4,1,""],BuildRawModel:[6,1,1,""],RawModelingResult:[6,4,1,""]},"sm.meld.RawModelingResult":{model:[6,3,1,""],gaps:[6,3,1,""]},"sm.meld.LoopCandidates":{SortByScore:[1,2,1,""],model:[1,3,1,""],SortByCorrel:[1,2,1,""],Add:[1,2,1,""]},promod3:{core:[7,0,1,""],meld:[9,0,1,""]}},titleterms:{pre:[0,7,9],own:10,modul:10,argument:0,indic:5,raw:6,api:[1,6],file:0,tabl:5,chang:4,your:10,unit:10,git:10,cmake:[8,10],welcom:5,how:10,make:8,write:10,start:10,build:8,branch:10,test:[10,0],"import":8,document:[10,5,2,3],promod3:[8,5,7],meld:9,"function":7,core:7,liter:[0,7,9],argcheck:0,contribut:10,standard:0,coordin:[9,6],user:3,releas:4,develop:2,line:0,"class":[0,7,9],stage:10,target:8,changelog:4,directori:10,docutil:[0,7,9],introduct:[0,6],structur:10,command:0,span:[0,7,9],model:[9,1,6],loop:1,depend:8}}) \ No newline at end of file diff --git a/doc/html/users.html b/doc/html/users.html index 4de84604288434d99ec0071cccb779830e684a63..3de4fbbf01838cd33b3175f280b43dae0c5a94ac 100644 --- a/doc/html/users.html +++ b/doc/html/users.html @@ -110,7 +110,7 @@ </div> <div class="footer"> © Copyright 2013, Bienchen. - Last updated on May 26 13:39, 2014. + Last updated on Jun 14 18:21, 2014. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b1. </div> </body>