Skip to content

Commit e5784e0

Browse files
committed
Deploy MDAnalysisData to github.com/MDAnalysis/MDAnalysisData.git:gh-pages
0 parents  commit e5784e0

70 files changed

Lines changed: 21812 additions & 0 deletions

Some content is hidden

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

.buildinfo

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

.nojekyll

Whitespace-only changes.

CG_fiber.html

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html xmlns="http://www.w3.org/1999/xhtml">
5+
<head>
6+
<meta charset="utf-8" />
7+
<title>CG fiber dataset &#8212; MDAnalysisData 0.8.0 documentation</title>
8+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
9+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
10+
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11+
<script type="text/javascript" src="_static/jquery.js"></script>
12+
<script type="text/javascript" src="_static/underscore.js"></script>
13+
<script type="text/javascript" src="_static/doctools.js"></script>
14+
<script type="text/javascript" src="_static/language_data.js"></script>
15+
<link rel="search" type="application/opensearchdescription+xml"
16+
title="Search within MDAnalysisData 0.8.0 documentation"
17+
href="_static/opensearch.xml"/>
18+
<link rel="shortcut icon" href="_static/mdanalysis-logo.ico"/>
19+
<link rel="index" title="Index" href="genindex.html" />
20+
<link rel="search" title="Search" href="search.html" />
21+
<link rel="prev" title="Vesicles datasets" href="vesicles.html" />
22+
23+
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
24+
25+
26+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
27+
28+
</head><body>
29+
30+
31+
<div class="document">
32+
<div class="documentwrapper">
33+
<div class="bodywrapper">
34+
35+
36+
<div class="body" role="main">
37+
38+
<div class="section" id="module-MDAnalysisData.CG_fiber">
39+
<span id="cg-fiber-dataset"></span><span id="cg-fiber"></span><h1>CG fiber dataset<a class="headerlink" href="#module-MDAnalysisData.CG_fiber" title="Permalink to this headline"></a></h1>
40+
<p>The <a class="reference internal" href="#module-MDAnalysisData.CG_fiber" title="MDAnalysisData.CG_fiber"><code class="xref py py-mod docutils literal notranslate"><span class="pre">MDAnalysisData.CG_fiber</span></code></a> module contains a coarse-grained
41+
MD trajectory showing the self-assembly of an amphiphilic molecule.</p>
42+
<table class="longtable docutils align-default">
43+
<colgroup>
44+
<col style="width: 10%" />
45+
<col style="width: 90%" />
46+
</colgroup>
47+
<tbody>
48+
<tr class="row-odd"><td><p><a class="reference internal" href="#MDAnalysisData.CG_fiber.fetch_CG_fiber" title="MDAnalysisData.CG_fiber.fetch_CG_fiber"><code class="xref py py-obj docutils literal notranslate"><span class="pre">fetch_CG_fiber</span></code></a>([data_home, download_if_missing])</p></td>
49+
<td><p>Load the CG fiber self-assembly trajectory</p></td>
50+
</tr>
51+
</tbody>
52+
</table>
53+
<div class="section" id="id1">
54+
<span id="id2"></span><h2>CG fiber dataset<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
55+
<p>MD trajectory showing the self-assembly of an amphiphilic molecule.</p>
56+
<p>The topology is contained in the PSF file (CHARMM format). The
57+
trajectory is contained in the DCD file (CHARMM/NAMD format).</p>
58+
<div class="section" id="notes">
59+
<h3>Notes<a class="headerlink" href="#notes" title="Permalink to this headline"></a></h3>
60+
<p>Data set characteristics:</p>
61+
<blockquote>
62+
<div><dl class="field-list simple">
63+
<dt class="field-odd">size</dt>
64+
<dd class="field-odd"><p>213 MB</p>
65+
</dd>
66+
<dt class="field-even">number of trajectories</dt>
67+
<dd class="field-even"><p>1</p>
68+
</dd>
69+
<dt class="field-odd">creator</dt>
70+
<dd class="field-odd"><p>Aysenur Iscen</p>
71+
</dd>
72+
<dt class="field-even">URL</dt>
73+
<dd class="field-even"><p><a class="reference external" href="https://figshare.com/articles/126chains_dcd/7259915">https://figshare.com/articles/126chains_dcd/7259915</a></p>
74+
</dd>
75+
<dt class="field-odd">license</dt>
76+
<dd class="field-odd"><p><a class="reference external" href="https://creativecommons.org/licenses/by/4.0/legalcode">CC-BY 4.0</a></p>
77+
</dd>
78+
</dl>
79+
</div></blockquote>
80+
<dl class="function">
81+
<dt id="MDAnalysisData.CG_fiber.fetch_CG_fiber">
82+
<code class="sig-prename descclassname">MDAnalysisData.CG_fiber.</code><code class="sig-name descname">fetch_CG_fiber</code><span class="sig-paren">(</span><em class="sig-param">data_home=None</em>, <em class="sig-param">download_if_missing=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MDAnalysisData/CG_fiber.html#fetch_CG_fiber"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MDAnalysisData.CG_fiber.fetch_CG_fiber" title="Permalink to this definition"></a></dt>
83+
<dd><p>Load the CG fiber self-assembly trajectory</p>
84+
<dl class="field-list simple">
85+
<dt class="field-odd">Parameters</dt>
86+
<dd class="field-odd"><ul class="simple">
87+
<li><p><strong>data_home</strong> (<em>optional</em><em>, </em><em>default: None</em>) – Specify another download and cache folder for the datasets. By default
88+
all MDAnalysisData data is stored in ‘~/MDAnalysis_data’ subfolders.
89+
This dataset is stored in <code class="docutils literal notranslate"><span class="pre">&lt;data_home&gt;/CG_fiber</span></code>.</p></li>
90+
<li><p><strong>download_if_missing</strong> (<em>optional</em><em>, </em><em>default=True</em>) – If <code class="docutils literal notranslate"><span class="pre">False</span></code>, raise a <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#IOError" title="(in Python v3.7)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IOError</span></code></a> if the data is not locally available
91+
instead of trying to download the data from the source site.</p></li>
92+
</ul>
93+
</dd>
94+
<dt class="field-even">Returns</dt>
95+
<dd class="field-even"><p><ul class="simple">
96+
<li><p><strong>dataset</strong> (<em>dict-like object with the following attributes:</em>)</p></li>
97+
<li><p><strong>dataset.topology</strong> (<em>filename</em>) – Filename of the topology file</p></li>
98+
<li><p><strong>dataset.trajectory</strong> (<em>filename</em>) – Filename of the trajectory file</p></li>
99+
<li><p><strong>dataset.DESCR</strong> (<em>string</em>) – Description of the trajectory.</p></li>
100+
</ul>
101+
</p>
102+
</dd>
103+
</dl>
104+
<p>See <a class="reference internal" href="#id1"><span class="std std-ref">CG fiber dataset</span></a> for description.</p>
105+
</dd></dl>
106+
107+
</div>
108+
</div>
109+
</div>
110+
111+
112+
</div>
113+
114+
</div>
115+
</div>
116+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
117+
<div class="sphinxsidebarwrapper">
118+
<p class="logo">
119+
<a href="index.html">
120+
<img class="logo" src="_static/logos/MDAnalysisData-logo.png" alt="Logo"/>
121+
122+
<h1 class="logo logo-name">MDAnalysisData</h1>
123+
124+
</a>
125+
</p>
126+
127+
128+
129+
<p class="blurb">Biomolecular simulation datasets</p>
130+
131+
132+
133+
134+
135+
136+
137+
138+
<h3>Navigation</h3>
139+
<p class="caption"><span class="caption-text">Overview</span></p>
140+
<ul>
141+
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing</a></li>
142+
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
143+
<li class="toctree-l1"><a class="reference internal" href="helpers.html">Helpers</a></li>
144+
<li class="toctree-l1"><a class="reference internal" href="credits.html">Credits</a></li>
145+
</ul>
146+
<p class="caption"><span class="caption-text">Datasets</span></p>
147+
<ul class="current">
148+
<li class="toctree-l1"><a class="reference internal" href="adk_equilibrium.html">AdK equilibrium dataset</a></li>
149+
<li class="toctree-l1"><a class="reference internal" href="adk_transitions.html">AdK transitions datasets</a></li>
150+
<li class="toctree-l1"><a class="reference internal" href="PEG_1chain.html">PEG polymer dataset</a></li>
151+
<li class="toctree-l1"><a class="reference internal" href="ifabp_water.html">I-FABP dataset</a></li>
152+
<li class="toctree-l1"><a class="reference internal" href="nhaa_equilibrium.html">NhaA equilibrium dataset</a></li>
153+
<li class="toctree-l1"><a class="reference internal" href="yiip_equilibrium.html">YiiP equilibrium dataset</a></li>
154+
<li class="toctree-l1"><a class="reference internal" href="membrane_peptide.html">Membrane peptide dataset</a></li>
155+
<li class="toctree-l1"><a class="reference internal" href="vesicles.html">Vesicles datasets</a></li>
156+
<li class="toctree-l1 current"><a class="current reference internal" href="#">CG fiber dataset</a></li>
157+
</ul>
158+
159+
160+
<hr />
161+
<ul>
162+
163+
<li class="toctree-l1"><a href="https://www.mdanalysis.org/">MDAnalysis</a></li>
164+
165+
<li class="toctree-l1"><a href="https://alchemtest.readthedocs.io/">alchemtest</a></li>
166+
167+
</ul>
168+
<div class="relations">
169+
<h3>Related Topics</h3>
170+
<ul>
171+
<li><a href="index.html">Documentation overview</a><ul>
172+
<li>Previous: <a href="vesicles.html" title="previous chapter">Vesicles datasets</a></li>
173+
</ul></li>
174+
</ul>
175+
</div>
176+
<div id="searchbox" style="display: none" role="search">
177+
<h3 id="searchlabel">Quick search</h3>
178+
<div class="searchformwrapper">
179+
<form class="search" action="search.html" method="get">
180+
<input type="text" name="q" aria-labelledby="searchlabel" />
181+
<input type="submit" value="Go" />
182+
</form>
183+
</div>
184+
</div>
185+
<script type="text/javascript">$('#searchbox').show(0);</script>
186+
</div>
187+
</div>
188+
<div class="clearer"></div>
189+
</div>
190+
<div class="footer">
191+
&copy;2018, Oliver Beckstein, Shujie Fan, Micaela Matta, Richard J. Gowers.
192+
193+
|
194+
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.1.2</a>
195+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
196+
197+
|
198+
<a href="_sources/CG_fiber.rst.txt"
199+
rel="nofollow">Page source</a>
200+
</div>
201+
202+
203+
<a href="https://github.com/MDAnalysis/MDAnalysisData" class="github">
204+
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
205+
</a>
206+
207+
208+
209+
</body>
210+
</html>

0 commit comments

Comments
 (0)