Skip to content

Commit

Permalink
Add stats.ipynb to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ohsOllila committed Dec 2, 2023
1 parent 17a7999 commit 0ecf86b
Show file tree
Hide file tree
Showing 12 changed files with 238 additions and 150 deletions.
Binary file modified Scripts/BuildDatabank/docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file not shown.
335 changes: 193 additions & 142 deletions Scripts/BuildDatabank/docs/build/html/_modules/searchDATABANK.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ Shows different kinds of rankings of simulations against experimental data.
`Template for more advance API usage <https://github.com/NMRLipids/databank-template/blob/main/scripts/template.ipynb>`_
------------------
Demonstrates the usage of API by three examples. 1) Selects a random simulation and prints the related databank content in human readable format. 2) Shows the readily analyzed properties for the selected random simulation (area per lipid, membrane thickness, relative equilibration times, X-ray scattering form factors, and C-H bond order parameters). 3) Selects a random simulation with the trajectory size below 100Mb and calculates P-N vector angle with respect to membrane normal for all lipids for which P and N atoms are available in headgroup.

`Showing statistics from the NMRlipids databank <https://github.com/NMRLipids/Databank/blob/main/Scripts/AnalyzeDatabank/stats.ipynb>`_
------------------
Plots distributions of simulation lengths, number of atoms and trajectory sizes, distribution of number of lipid components, available single component bilayers and binary lipid mixtures, and pie diagram of temperatures.
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
<li class="toctree-l2"><a class="reference internal" href="#id1">Plotting basic simulation properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id2">Show ranking tables of simulations based in their quality against experimental data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id3">Template for more advance API usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id4">Showing statistics from the NMRlipids databank</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -96,6 +97,10 @@ <h2><a class="reference external" href="https://github.com/NMRLipids/databank-te
<h2><a class="reference external" href="https://github.com/NMRLipids/databank-template/blob/main/scripts/template.ipynb">Template for more advance API usage</a><a class="headerlink" href="#id3" title="Link to this heading"></a></h2>
<p>Demonstrates the usage of API by three examples. 1) Selects a random simulation and prints the related databank content in human readable format. 2) Shows the readily analyzed properties for the selected random simulation (area per lipid, membrane thickness, relative equilibration times, X-ray scattering form factors, and C-H bond order parameters). 3) Selects a random simulation with the trajectory size below 100Mb and calculates P-N vector angle with respect to membrane normal for all lipids for which P and N atoms are available in headgroup.</p>
</section>
<section id="id4">
<h2><a class="reference external" href="https://github.com/NMRLipids/Databank/blob/main/Scripts/AnalyzeDatabank/stats.ipynb">Showing statistics from the NMRlipids databank</a><a class="headerlink" href="#id4" title="Link to this heading"></a></h2>
<p>Plots distributions of simulation lengths, number of atoms and trajectory sizes, distribution of number of lipid components, available single component bilayers and binary lipid mixtures, and pie diagram of temperatures.</p>
</section>
</section>


Expand Down
6 changes: 6 additions & 0 deletions Scripts/BuildDatabank/docs/build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -342,14 +342,20 @@ <h2 id="L">L</h2>
<li><a href="searchDATABANK.html#searchDATABANK.loadSimulations">(in module searchDATABANK)</a>
</li>
</ul></li>
<li><a href="searchDATABANK.html#searchDATABANK.logPairs">logPairs() (in module searchDATABANK)</a>
</li>
</ul></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="buildH_calcOP_test.html#buildH_calcOP_test.main">main() (in module buildH_calcOP_test)</a>

<ul>
<li><a href="searchDATABANK.html#searchDATABANK.main">(in module searchDATABANK)</a>
</li>
</ul></li>
<li><a href="buildH_calcOP_test.html#buildH_calcOP_test.make_dic_atname2genericname">make_dic_atname2genericname() (in module buildH_calcOP_test)</a>
</li>
<li><a href="buildH_calcOP_test.html#buildH_calcOP_test.make_dic_Cname2Hnames">make_dic_Cname2Hnames() (in module buildH_calcOP_test)</a>
Expand Down
1 change: 1 addition & 0 deletions Scripts/BuildDatabank/docs/build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ <h2>System requirements<a class="headerlink" href="#system-requirements" title="
<li class="toctree-l2"><a class="reference internal" href="exampleAndTutorials.html#id1">Plotting basic simulation properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="exampleAndTutorials.html#id2">Show ranking tables of simulations based in their quality against experimental data</a></li>
<li class="toctree-l2"><a class="reference internal" href="exampleAndTutorials.html#id3">Template for more advance API usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="exampleAndTutorials.html#id4">Showing statistics from the NMRlipids databank</a></li>
</ul>
</li>
</ul>
Expand Down
Binary file modified Scripts/BuildDatabank/docs/build/html/objects.inv
Binary file not shown.
31 changes: 24 additions & 7 deletions Scripts/BuildDatabank/docs/build/html/searchDATABANK.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Scripts/BuildDatabank/docs/build/html/searchindex.js

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions Scripts/BuildDatabank/docs/source/exampleAndTutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,7 @@ Shows different kinds of rankings of simulations against experimental data.
`Template for more advance API usage <https://github.com/NMRLipids/databank-template/blob/main/scripts/template.ipynb>`_
------------------
Demonstrates the usage of API by three examples. 1) Selects a random simulation and prints the related databank content in human readable format. 2) Shows the readily analyzed properties for the selected random simulation (area per lipid, membrane thickness, relative equilibration times, X-ray scattering form factors, and C-H bond order parameters). 3) Selects a random simulation with the trajectory size below 100Mb and calculates P-N vector angle with respect to membrane normal for all lipids for which P and N atoms are available in headgroup.

`Showing statistics from the NMRlipids databank <https://github.com/NMRLipids/Databank/blob/main/Scripts/AnalyzeDatabank/stats.ipynb>`_
------------------
Plots distributions of simulation lengths, number of atoms and trajectory sizes, distribution of number of lipid components, available single component bilayers and binary lipid mixtures, and pie diagram of temperatures.

0 comments on commit 0ecf86b

Please sign in to comment.