Skip to content

Commit 5ba110a

Browse files
author
github-actions
committed
deploy: 5cde331 
1 parent 61681ad commit 5ba110a

55 files changed

Lines changed: 14296 additions & 15131 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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 04d4f67efb4980f1cb4b5c4325fb2d69
3+
config: d4c0879ad33f7abf8b8b860ecd81dd12
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎CG_fiber.html‎

Lines changed: 109 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,41 @@
1+
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
<head>
12+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css" integrity="sha512-iBBXm8fW90+nuLcSKlbmrPcLa0OT92xO1BIsZ+ywDWZCvqsWgccV3gFoRBv0z+8dLJgyAHIhR35VZc2oM/gI1w==" crossorigin="anonymous" referrerpolicy="no-referrer" />
13+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/academicons/1.9.1/css/academicons.min.css" integrity="sha512-b1ASx0WHgVFL5ZQhTgiPWX+68KjS38Jk87jg7pe+qC7q9YkEtFq0z7xCglv7qGIs/68d3mAp+StfC8WKC5SSAg==" crossorigin="anonymous" referrerpolicy="no-referrer" />
14+
<link rel="shortcut icon" href="_static/logo/mda_favicon.ico">
15+
</head>
16+
117
<!DOCTYPE html>
218
<html class="writer-html5" lang="en" >
319
<head>
4-
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
20+
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
521

622
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>CG fiber dataset &mdash; MDAnalysisData 0.8.1+1.g98c6b34 documentation</title>
23+
<title>CG fiber dataset &mdash; MDAnalysisData 0.8.1+10.g5cde331 documentation</title>
824
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
9-
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
10-
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
11-
<link rel="shortcut icon" href="_static/mdanalysis-logo.ico"/>
25+
<link rel="stylesheet" href="_static/site.css" type="text/css" />
1226
<!--[if lt IE 9]>
1327
<script src="_static/js/html5shiv.min.js"></script>
1428
<![endif]-->
1529

16-
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
17-
<script src="_static/jquery.js"></script>
18-
<script src="_static/underscore.js"></script>
19-
<script src="_static/doctools.js"></script>
30+
<script src="_static/jquery.js?v=5d32c60e"></script>
31+
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
32+
<script src="_static/documentation_options.js?v=fe7544d9"></script>
33+
<script src="_static/doctools.js?v=888ff710"></script>
34+
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
35+
<script src="_static/js/versions.js"></script>
2036
<script src="_static/js/theme.js"></script>
2137
<link rel="search" type="application/opensearchdescription+xml"
22-
title="Search within MDAnalysisData 0.8.1+1.g98c6b34 documentation"
38+
title="Search within MDAnalysisData 0.8.1+10.g5cde331 documentation"
2339
href="_static/opensearch.xml"/>
2440
<link rel="index" title="Index" href="genindex.html" />
2541
<link rel="search" title="Search" href="search.html" />
@@ -30,22 +46,44 @@
3046
<div class="wy-grid-for-nav">
3147
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
3248
<div class="wy-side-scroll">
33-
<div class="wy-side-nav-search" style="background: white" >
34-
<a href="index.html">
35-
<img src="_static/MDAnalysisData-logo.png" class="logo" alt="Logo"/>
36-
</a>
37-
<div class="version">
38-
0.8
39-
</div>
49+
<div class="wy-side-nav-search" >
50+
51+
52+
53+
54+
55+
56+
57+
58+
59+
<a href="index.html">
60+
61+
<img src="_static/MDAnalysisData-logo.png" class="logo" alt="Logo"/>
62+
</a>
63+
64+
65+
66+
67+
68+
<div class="version">
69+
0.8
70+
</div>
71+
72+
73+
74+
4075
<div role="search">
4176
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
42-
<input type="text" name="q" placeholder="Search docs" />
77+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
4378
<input type="hidden" name="check_keywords" value="yes" />
4479
<input type="hidden" name="area" value="default" />
4580
</form>
4681
</div>
47-
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
48-
<p class="caption" role="heading"><span class="caption-text">Overview</span></p>
82+
83+
</div>
84+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
85+
86+
<p class="caption" role="heading"><span class="caption-text">Overview</span></p>
4987
<ul>
5088
<li class="toctree-l1"><a class="reference internal" href="install.html">Installing</a></li>
5189
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
@@ -65,18 +103,22 @@
65103
<li class="toctree-l1"><a class="reference internal" href="vesicles.html">Vesicles datasets</a></li>
66104
<li class="toctree-l1 current"><a class="current reference internal" href="#">CG fiber dataset</a><ul>
67105
<li class="toctree-l2"><a class="reference internal" href="#id1">CG fiber dataset</a><ul>
68-
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a></li>
106+
<li class="toctree-l3"><a class="reference internal" href="#notes">Notes</a><ul>
107+
<li class="toctree-l4"><a class="reference internal" href="#MDAnalysisData.CG_fiber.fetch_CG_fiber"><code class="docutils literal notranslate"><span class="pre">fetch_CG_fiber()</span></code></a></li>
108+
</ul>
109+
</li>
69110
</ul>
70111
</li>
71112
</ul>
72113
</li>
73114
</ul>
74115

75-
</div>
116+
</div>
117+
76118
</div>
77119
</nav>
78120

79-
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: white" >
121+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
80122
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
81123
<a href="index.html">MDAnalysisData</a>
82124
</nav>
@@ -85,8 +127,8 @@
85127
<div class="rst-content">
86128
<div role="navigation" aria-label="Page navigation">
87129
<ul class="wy-breadcrumbs">
88-
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
89-
<li>CG fiber dataset</li>
130+
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
131+
<li class="breadcrumb-item active">CG fiber dataset</li>
90132
<li class="wy-breadcrumbs-aside">
91133
<a href="_sources/CG_fiber.rst.txt" rel="nofollow"> View page source</a>
92134
</li>
@@ -97,62 +139,58 @@
97139
<div itemprop="articleBody">
98140

99141
<section id="module-MDAnalysisData.CG_fiber">
100-
<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>
142+
<span id="cg-fiber-dataset"></span><span id="cg-fiber"></span><h1>CG fiber dataset<a class="headerlink" href="#module-MDAnalysisData.CG_fiber" title="Link to this heading"></a></h1>
101143
<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
102144
MD trajectory showing the self-assembly of an amphiphilic molecule.</p>
103-
<table class="longtable docutils align-default">
104-
<colgroup>
105-
<col style="width: 10%" />
106-
<col style="width: 90%" />
107-
</colgroup>
145+
<table class="autosummary longtable docutils align-default">
108146
<tbody>
109147
<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>
110148
<td><p>Load the CG fiber self-assembly trajectory</p></td>
111149
</tr>
112150
</tbody>
113151
</table>
114152
<section id="id1">
115-
<span id="id2"></span><h2>CG fiber dataset<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h2>
153+
<span id="id2"></span><h2>CG fiber dataset<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
116154
<p>MD trajectory showing the self-assembly of an amphiphilic molecule.</p>
117155
<p>The topology is contained in the PSF file (CHARMM format). The
118156
trajectory is contained in the DCD file (CHARMM/NAMD format).</p>
119157
<section id="notes">
120-
<h3>Notes<a class="headerlink" href="#notes" title="Permalink to this headline"></a></h3>
158+
<h3>Notes<a class="headerlink" href="#notes" title="Link to this heading"></a></h3>
121159
<p>Data set characteristics:</p>
122160
<blockquote>
123161
<div><dl class="field-list simple">
124-
<dt class="field-odd">size</dt>
162+
<dt class="field-odd">size<span class="colon">:</span></dt>
125163
<dd class="field-odd"><p>213 MB</p>
126164
</dd>
127-
<dt class="field-even">number of trajectories</dt>
165+
<dt class="field-even">number of trajectories<span class="colon">:</span></dt>
128166
<dd class="field-even"><p>1</p>
129167
</dd>
130-
<dt class="field-odd">creator</dt>
168+
<dt class="field-odd">creator<span class="colon">:</span></dt>
131169
<dd class="field-odd"><p>Aysenur Iscen</p>
132170
</dd>
133-
<dt class="field-even">URL</dt>
171+
<dt class="field-even">URL<span class="colon">:</span></dt>
134172
<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>
135173
</dd>
136-
<dt class="field-odd">license</dt>
174+
<dt class="field-odd">license<span class="colon">:</span></dt>
137175
<dd class="field-odd"><p><a class="reference external" href="https://creativecommons.org/licenses/by/4.0/legalcode">CC-BY 4.0</a></p>
138176
</dd>
139177
</dl>
140178
</div></blockquote>
141179
<dl class="py function">
142180
<dt class="sig sig-object py" id="MDAnalysisData.CG_fiber.fetch_CG_fiber">
143-
<span class="sig-prename descclassname"><span class="pre">MDAnalysisData.CG_fiber.</span></span><span class="sig-name descname"><span class="pre">fetch_CG_fiber</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_home</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_if_missing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MDAnalysisData/CG_fiber.html#fetch_CG_fiber"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MDAnalysisData.CG_fiber.fetch_CG_fiber" title="Permalink to this definition"></a></dt>
181+
<span class="sig-prename descclassname"><span class="pre">MDAnalysisData.CG_fiber.</span></span><span class="sig-name descname"><span class="pre">fetch_CG_fiber</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data_home</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_if_missing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MDAnalysisData/CG_fiber.html#fetch_CG_fiber"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#MDAnalysisData.CG_fiber.fetch_CG_fiber" title="Link to this definition"></a></dt>
144182
<dd><p>Load the CG fiber self-assembly trajectory</p>
145183
<dl class="field-list simple">
146-
<dt class="field-odd">Parameters</dt>
184+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
147185
<dd class="field-odd"><ul class="simple">
148186
<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
149187
all MDAnalysisData data is stored in ‘~/MDAnalysis_data’ subfolders.
150188
This dataset is stored in <code class="docutils literal notranslate"><span class="pre">&lt;data_home&gt;/CG_fiber</span></code>.</p></li>
151-
<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.10)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IOError</span></code></a> if the data is not locally available
189+
<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.12)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">IOError</span></code></a> if the data is not locally available
152190
instead of trying to download the data from the source site.</p></li>
153191
</ul>
154192
</dd>
155-
<dt class="field-even">Returns</dt>
193+
<dt class="field-even">Returns<span class="colon">:</span></dt>
156194
<dd class="field-even"><p><ul class="simple">
157195
<li><p><strong>dataset</strong> (<em>dict-like object with the following attributes:</em>)</p></li>
158196
<li><p><strong>dataset.topology</strong> (<em>filename</em>) – Filename of the topology file</p></li>
@@ -179,14 +217,20 @@ <h3>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">
179217
<hr/>
180218

181219
<div role="contentinfo">
182-
<p>&#169; Copyright 2018-2021, Oliver Beckstein, Shujie Fan, Richard J. Gowers, Micaela Matta, and Lily Wang.</p>
220+
<p>&#169; Copyright 2018-2023, Irfan Alibay, Oliver Beckstein, Shujie Fan, Richard J. Gowers, Micaela Matta, and Lily Wang.</p>
183221
</div>
184222

185-
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
186-
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
187-
provided by <a href="https://readthedocs.org">Read the Docs</a>.
188223

189-
224+
225+
226+
<div class="footer"><p>Please see
227+
our <a href="https://www.mdanalysis.org/pages/privacy/">Privacy Policy</a>
228+
to learn how <a href="https://www.mdanalysis.org">MDAnalysis</a> collects data.</p>
229+
<script data-goatcounter="https://mdanalysis.goatcounter.com/count"
230+
async src="//gc.zgo.at/count.js"></script>
231+
</div>
232+
233+
190234
<div class="footer"><p>Please see
191235
our <a href="https://www.mdanalysis.org/pages/privacy/">Privacy Policy</a>
192236
to learn how <a href="https://www.mdanalysis.org">MDAnalysis</a> collects data.</p>
@@ -201,6 +245,24 @@ <h3>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">
201245
</section>
202246
</div>
203247
<script>
248+
var versions_json_url = ''
249+
</script>
250+
251+
<div class="rst-versions" data-toggle="rst-versions" role="note"
252+
aria-label="versions">
253+
<span class="rst-current-version" data-toggle="rst-current-version">
254+
<span class="fa fa-book"></span>
255+
0.8.1+10.g5cde331
256+
<span class="fa fa-caret-down"></span>
257+
</span>
258+
259+
<div class="rst-other-versions">
260+
<dl id="versionselector">
261+
<dt>Other Versions</dt>
262+
</dl>
263+
264+
</div>
265+
</div><script>
204266
jQuery(function () {
205267
SphinxRtdTheme.Navigation.enable(true);
206268
});

0 commit comments

Comments
 (0)