Skip to content
Snippets Groups Projects
Select Git revision
  • 1c18256b28680c2b23e8c1a90fd451b7b7413a08
  • master default protected
  • develop protected
  • cmake_boost_refactor
  • ubuntu_ci
  • mmtf
  • non-orthogonal-maps
  • no_boost_filesystem
  • data_viewer
  • 2.11.1
  • 2.11.0
  • 2.10.0
  • 2.9.3
  • 2.9.2
  • 2.9.1
  • 2.9.0
  • 2.8.0
  • 2.7.0
  • 2.6.1
  • 2.6.0
  • 2.6.0-rc4
  • 2.6.0-rc3
  • 2.6.0-rc2
  • 2.6.0-rc
  • 2.5.0
  • 2.5.0-rc2
  • 2.5.0-rc
  • 2.4.0
  • 2.4.0-rc2
29 results

__init__.py

Blame
    • developers.html 7.33 KiB 
    
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>Documentation For Developers &#8212; ProMod3 3.1.1 documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="ProMod3 Setup" href="dev_setup.html" />
    <link rel="prev" title="Contributing" href="user_contributions.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="documentation-for-developers">
<h1>Documentation For Developers<a class="headerlink" href="#documentation-for-developers" title="Permalink to this headline">¶</a></h1>
<p>This section is for developers that wish to extending the functionality of
ProMod3. It describes helper classes for development and how to contribute
new features.</p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="dev_setup.html">ProMod3 Setup</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dev_setup.html#git-branches">Git Branches</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev_setup.html#git-hooks">Git Hooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev_setup.html#directory-structure">Directory Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev_setup.html#cmake">CMake</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev_setup.html#the-stage-directory">The <code class="file docutils literal notranslate"><span class="pre">stage</span></code> Directory</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#how-to-share-your-own-script">How To Share Your Own Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#how-to-start-your-own-module">How To Start Your Own Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#how-to-start-your-own-action">How To Start Your Own Action</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#how-to-write-your-own-scorer">How To Write Your Own Scorer</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#quick-testing-of-project-features">Quick testing of ProMod3 features</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#unit-tests">Unit Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#writing-documentation">Writing Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributing.html#third-party-contributions-license-issues">Third Party Contributions (License Issues)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="actions/index_dev.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">test_actions</span></code> - Testing Actions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="actions/index_dev.html#creating-an-action-unit-test-script">Creating an Action Unit Test Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="actions/index_dev.html#unit-test-actions-api">Unit Test Actions API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cmake/index.html">ProMod3’s Share Of CMake</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cmake/index.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="cmake/index.html#functions-for-module-action-maintenance">Functions For Module/ Action Maintenance</a></li>
    </ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="portableIO.html">Using Binary Files In ProMod3</a><ul>
<li class="toctree-l2"><a class="reference internal" href="portableIO.html#file-header">File Header</a></li>
<li class="toctree-l2"><a class="reference internal" href="portableIO.html#portable-binary-data">Portable Binary Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="portableIO.html#code-example">Code Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="portableIO.html#exisiting-binary-files">Exisiting Binary Files</a></li>
</ul>
</li>
</ul>
</div>
</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">ProMod3</a></h1>








<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="users.html">Users</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
      <li>Previous: <a href="user_contributions.html" title="previous chapter">Contributing</a></li>
      <li>Next: <a href="dev_setup.html" title="next chapter">ProMod3 Setup</a></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
        </div>
    <div class="footer">
      &copy;2013-2020, SIB - Swiss Institute of Bioinformatics and Biozentrum - University of Basel.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.1.2</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="_sources/developers.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>