Something went wrong on our end
-
stefan authored
git-svn-id: https://dng.biozentrum.unibas.ch/svn/openstructure/trunk@2373 5a81b35b-ba03-0410-adc8-b2c5c5119f08
stefan authoredgit-svn-id: https://dng.biozentrum.unibas.ch/svn/openstructure/trunk@2373 5a81b35b-ba03-0410-adc8-b2c5c5119f08
index.html 13.68 KiB
<!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>OpenStructure documentation — OpenStructure v1.0 documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.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="OpenStructure v1.0 documentation" href="#" />
<link rel="next" title="A gentle introduction to OpenStructure" href="intro.html" />
</head>
<body>
<div class="related">
<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="intro.html" title="A gentle introduction to OpenStructure"
accesskey="N">next</a> |</li>
<li><a href="#">OpenStructure v1.0 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">OpenStructure documentation</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#modules">Modules</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#extending-openstructure">Extending OpenStructure</a><ul>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="intro.html"
title="next chapter">A gentle introduction to OpenStructure</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none"> <h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<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="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="openstructure-documentation">
<h1>OpenStructure documentation<a class="headerlink" href="#openstructure-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul class="simple">
</ul>
</div>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">A gentle introduction to OpenStructure</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#what-will-be-covered-in-this-tutorial">What will be covered in this tutorial?</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#getting-ready-to-rumble">Getting ready to rumble</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#loading-and-inspecting-a-protein-structure">Loading and inspecting a protein structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#let-there-be-shiny-graphics">Let There Be Shiny Graphics</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#introduction-to-views">Introduction to Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#the-query-language">The Query Language</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#constructing-views-manually">Constructing Views Manually</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#saving-an-entity">Saving an Entity</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#loading-images-and-density-maps">Loading images and density maps</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#manipulating-images-and-density-maps">Manipulating images and density maps</a></li>
<li class="toctree-l2"><a class="reference internal" href="intro.html#displaying-images-and-density-maps">Displaying images and density maps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing OpenStructure</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-the-dependencies">Installing the Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#checking-out-the-source">Checking out the Source</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#configuring">Configuring</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#building-the-project">Building the Project</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="base/generic.html">Storing Custom Data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="base/generic.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="base/generic.html#storing-and-accessing-data">Storing and Accessing Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="base/generic.html#use-of-generic-properties-in-queries">Use of Generic Properties in Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="base/generic.html#api-documentation">API documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="img/base/img.html"><tt class="docutils literal"><span class="pre">img</span></tt> Images and Density Maps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="img/base/img.html#introduction-the-imagehandle">Introduction : The ImageHandle</a></li>
<li class="toctree-l2"><a class="reference internal" href="img/base/img.html#creating-and-visualizing-imagehandles">Creating and visualizing ImageHandles</a></li>
<li class="toctree-l2"><a class="reference internal" href="img/base/img.html#reading-and-writing-into-an-image">Reading and writing into an image</a></li>
<li class="toctree-l2"><a class="reference internal" href="img/base/img.html#applying-a-fourier-transform">Applying a Fourier Transform</a></li><li class="toctree-l2"><a class="reference internal" href="img/base/img.html#extracting-and-pasting-images">Extracting and Pasting Images</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="img/alg/alg.html"><tt class="docutils literal"><span class="pre">alg</span></tt> - Image Processing Algorithms</a><ul>
<li class="toctree-l2"><a class="reference internal" href="img/alg/alg.html#usage-of-image-algorithms">Usage of Image Algorithms</a></li>
<li class="toctree-l2"><a class="reference internal" href="img/alg/alg.html#filters-in-fourier-space">Filters in Fourier Space</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="geom/geom.html"><tt class="docutils literal"><span class="pre">geom</span></tt> – vectors, matrices and geometrical objects</a><ul>
<li class="toctree-l2"><a class="reference internal" href="geom/vec.html">Vectors</a></li>
<li class="toctree-l2"><a class="reference internal" href="geom/mat.html">Matrices</a></li>
<li class="toctree-l2"><a class="reference internal" href="geom/composite.html">Geometric Objects</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="conop/conop.html"><tt class="docutils literal"><span class="pre">conop</span></tt> – Connectivity and Topology of Molecules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="conop/conop.html#motivation">Motivation</a></li>
<li class="toctree-l2"><a class="reference internal" href="conop/conop.html#the-builder-interface">The Builder interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="conop/conop.html#connecting-atoms">Connecting atoms</a></li>
<li class="toctree-l2"><a class="reference internal" href="conop/conop.html#convert-mm-cif-dictionary">Convert MM CIF dictionary</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="mol/base/mol.html"><tt class="docutils literal"><span class="pre">mol</span></tt> – Molecular structures and surfaces</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mol/base/entity.html">The Molecular Entity</a></li>
<li class="toctree-l2"><a class="reference internal" href="mol/base/editors.html">Editors</a></li>
<li class="toctree-l2"><a class="reference internal" href="mol/base/query.html">Queries</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="seq/base/seq.html"><tt class="docutils literal"><span class="pre">seq</span></tt> – Sequences and Alignments</a><ul>
<li class="toctree-l2"><a class="reference internal" href="seq/base/seq.html#attaching-structures-to-sequences">Attaching Structures to Sequences</a></li>
<li class="toctree-l2"><a class="reference internal" href="seq/base/seq.html#loading-and-saving-sequences-and-alignments">Loading and Saving Sequences and Alignments</a></li>
<li class="toctree-l2"><a class="reference internal" href="seq/base/seq.html#the-sequencehandle">The SequenceHandle</a></li>
<li class="toctree-l2"><a class="reference internal" href="seq/base/seq.html#the-sequencelist">The SequenceList</a></li>
<li class="toctree-l2"><a class="reference internal" href="seq/base/seq.html#the-alignmenthandle">The AlignmentHandle</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="base/base.html"><tt class="docutils literal"><span class="pre">ost.settings</span></tt> - Locate Files and Retrieve Preferences</a></li>
<li class="toctree-l1"><a class="reference internal" href="io/io.html"><tt class="docutils literal"><span class="pre">io</span></tt> - Input and Output of Sequences, Structures and Maps</a><ul>
<li class="toctree-l2"><a class="reference internal" href="io/io.html#molecular-structures">Molecular Structures</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gui/gui.html"><tt class="docutils literal"><span class="pre">gui</span></tt> – Graphical User Interface</a></li>
</ul>
</div>
</div>
<div class="section" id="extending-openstructure">
<h2>Extending OpenStructure<a class="headerlink" href="#extending-openstructure" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="newmodule.html">Creating a New Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="newmodule.html#directory-structure">Directory Structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="newmodule.html#the-module-code">The Module Code</a></li>
<li class="toctree-l2"><a class="reference internal" href="newmodule.html#the-testing-framework">The Testing Framework</a></li>
<li class="toctree-l2"><a class="reference internal" href="newmodule.html#the-python-wrapper">The Python Wrapper</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="external.html">Using External Programs within OpenStructure</a><ul>
<li class="toctree-l2"><a class="reference internal" href="external.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="external.html#locating-the-executable">Locating the Executable</a></li>
<li class="toctree-l2"><a class="reference internal" href="external.html#prepare-all-files">Prepare All Files</a></li>
<li class="toctree-l2"><a class="reference internal" href="external.html#execute-the-external-program">Execute the External Program</a></li>
<li class="toctree-l2"><a class="reference internal" href="external.html#read-generated-output">Read Generated Output</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div> </div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="intro.html" title="A gentle introduction to OpenStructure"
>next</a> |</li>
<li><a href="#">OpenStructure v1.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, OpenStructure authors.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b2.
</div>
</body>
</html>