build based on f1c664c

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-05T20:02:54","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-05T20:43:20","documenter_version":"1.5.0"}}

dev/contributions/index.html

@@ -63,7 +63,7 @@
 rc2 = ResidueContributions(result2, select(atoms, "protein"))
 # difference of the residue contributions between the two simulations:
 rc_diff = rc2 - rc1
-contourf(rc_diff) # plots a contour map of the difference</code></pre><div class="admonition is-compat"><header class="admonition-header">Compat</header><div class="admonition-body"><p>Slicing, indexing, and multiplication and divison by scalars were introduces in v2.7.0.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/m3g/ComplexMixtures.jl/blob/9e0c89a69e9bf312abb1c38f650fbd937e3d89dc/src/tools/residue_contributions.jl#L1-L104">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ComplexMixtures.contributions-Tuple{Result, Union{SoluteGroup, SolventGroup}}" href="#ComplexMixtures.contributions-Tuple{Result, Union{SoluteGroup, SolventGroup}}"><code>ComplexMixtures.contributions</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">contributions(R::Result, group::Union{SoluteGroup,SolventGroup}; type = :mddf)</code></pre><p>Returns the contributions of the atoms of the solute or solvent to the MDDF, coordination number, or MD count.</p><p><strong>Arguments</strong></p><ul><li><code>R::Result</code>: The result of a calculation.</li><li><code>group::Union{SoluteGroup,SolventGroup}</code>: The group of atoms to consider.</li><li><code>type::Symbol</code>: The type of contributions to return. Can be <code>:mddf</code> (default), <code>:coordination_number</code>, or <code>:md_count</code>.</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using ComplexMixtures, PDBTools
+contourf(rc_diff) # plots a contour map of the difference</code></pre><div class="admonition is-compat"><header class="admonition-header">Compat</header><div class="admonition-body"><p>Slicing, indexing, and multiplication and divison by scalars were introduces in v2.7.0.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/m3g/ComplexMixtures.jl/blob/f1c664c3ac5ab9b99569dd98028df218a6934f2d/src/tools/residue_contributions.jl#L1-L104">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ComplexMixtures.contributions-Tuple{Result, Union{SoluteGroup, SolventGroup}}" href="#ComplexMixtures.contributions-Tuple{Result, Union{SoluteGroup, SolventGroup}}"><code>ComplexMixtures.contributions</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">contributions(R::Result, group::Union{SoluteGroup,SolventGroup}; type = :mddf)</code></pre><p>Returns the contributions of the atoms of the solute or solvent to the MDDF, coordination number, or MD count.</p><p><strong>Arguments</strong></p><ul><li><code>R::Result</code>: The result of a calculation.</li><li><code>group::Union{SoluteGroup,SolventGroup}</code>: The group of atoms to consider.</li><li><code>type::Symbol</code>: The type of contributions to return. Can be <code>:mddf</code> (default), <code>:coordination_number</code>, or <code>:md_count</code>.</li></ul><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; using ComplexMixtures, PDBTools
 
 julia&gt; dir = ComplexMixtures.Testing.data_dir*&quot;/Gromacs&quot;;
 
@@ -89,4 +89,4 @@
 
 julia&gt; ca_cb = contributions(results, SoluteGroup([&quot;CA&quot;, &quot;CB&quot;])); # contribution of CA and CB atoms to the MDDF
 
-julia&gt; ca_cb = contributions(results, SoluteGroup([&quot;CA&quot;, &quot;CB&quot;]); type=:coordination_number); # contribution of CA and CB atoms to the coordination number</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/m3g/ComplexMixtures.jl/blob/9e0c89a69e9bf312abb1c38f650fbd937e3d89dc/src/tools/contributions.jl#L1-L44">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../results/">« Results</a><a class="docs-footer-nextpage" href="../save/">Save and load »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Monday 5 August 2024 20:02">Monday 5 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; ca_cb = contributions(results, SoluteGroup([&quot;CA&quot;, &quot;CB&quot;]); type=:coordination_number); # contribution of CA and CB atoms to the coordination number</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/m3g/ComplexMixtures.jl/blob/f1c664c3ac5ab9b99569dd98028df218a6934f2d/src/tools/contributions.jl#L1-L44">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../results/">« Results</a><a class="docs-footer-nextpage" href="../save/">Save and load »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Monday 5 August 2024 20:43">Monday 5 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/example1/index.html

@@ -153,4 +153,4 @@
 <img width=100% src="https://github.com/m3g/ComplexMixturesExamples/raw/main/Protein_in_Glycerol/Density3D/density3D_final.png">
 </center><p>In the figure on the left, the points in space around the protein are selected with the following properties: distance from the protein smaller than 2.0Å and relative contribution to the MDDF at the corresponding distance of at least 10% of the maximum contribution. Thus, we are selecting the regions of the protein corresponding to the most stable hydrogen-bonding interactions. The color of the points is the contribution to the MDDF, from blue to red. Thus, the most reddish-points corresponds to the regions where the most stable hydrogen bonds were formed. We have marked two regions here, on opposite sides of the protein, with arrows.</p><p>Clicking on those points we obtain which are the atoms of the protein contributing to the MDDF at that region. In particular, the arrow on the right points to the strongest red region, which corresponds to an Aspartic acid. These residues are shown explicitly under the density (represented as a transparent surface) on the figure in the center.</p><p>The figure on the right displays, overlapped with the hydrogen-bonding residues, the most important contributions to the second peak of the distribution, corresponding to distances from the protein between 2.0 and 3.5Å. Notably, the regions involved are different from the ones forming hydrogen bonds, indicating that non-specific interactions with the protein (and not a second solvation shell) are responsible for the second peak. </p><h3 id="How-to-run-this-example:"><a class="docs-heading-anchor" href="#How-to-run-this-example:">How to run this example:</a><a id="How-to-run-this-example:-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-run-this-example:" title="Permalink"></a></h3><p>Assuming that the input files are available in the script directory, just run the script with:</p><pre><code class="language-bash hljs">julia density3D.jl</code></pre><p>Alternatively, open Julia and copy/paste or the commands in <code>density3D.jl</code> or use <code>include(&quot;./density3D.jl&quot;)</code>. These options will allow you to remain on the Julia section with access to the <code>grid</code> data structure that was generated and corresponds to the output <code>grid.pdb</code> file. </p><p>This will create the <code>grid.pdb</code> file. <a href="../assets/scripts/example1/grid.vmd">Here</a> we provide a previously setup VMD session that contains the data with the visualization choices used to generate the figure above. Load it with:</p><pre><code class="language-bash hljs">vmd -e grid.vmd</code></pre><p>A short tutorial video showing how to open the input and output PDB files in VMD and produce images of the density is available here: </p><center>
 <iframe width="560" style="height:315px" src="https://www.youtube.com/embed/V4Py44IKDh8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
-</center></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/">« Examples:</a><a class="docs-footer-nextpage" href="../example2/">◦ Polyacrylamide in DMF »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Monday 5 August 2024 20:02">Monday 5 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</center></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/">« Examples:</a><a class="docs-footer-nextpage" href="../example2/">◦ Polyacrylamide in DMF »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Monday 5 August 2024 20:43">Monday 5 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/example2/index.html

@@ -250,4 +250,4 @@
 savefig("./map2D_acr.png")
 println(&quot;Plot saved to map2D_acr.png&quot;)</code></pre></details><br><h4 id="Output-3"><a class="docs-heading-anchor" href="#Output-3">Output</a><a class="docs-heading-anchor-permalink" href="#Output-3" title="Permalink"></a></h4><p>The terminal methyl groups interact strongly with DMF, and strong local density augmentations are visible in particular on the amine groups. These occur at less than 2.0Angs and are characteristic of hydrogen-bond interactions. Interestingly, the DMF molecules are excluded from the aliphatic and carbonyl groups of the polymer, relative to the other groups.</p><p>Finally, it is noticeable that the central mer is more weakly solvated by DMF than the mers approaching the extremes of the polymer chain. This is likely a result of the partial folding of the polymer, that protects that central mers from the solvent in a fraction of the polymer configurations.</p><center>
 <img width=70% src="../assets/scripts/example2/map2D_acr.png">
-</center><h3 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h3><p>Molecules built with JSME: B. Bienfait and P. Ertl, JSME: a free molecule editor in JavaScript, Journal of Cheminformatics 5:24 (2013) <a href="http://biomodel.uah.es/en/DIY/JSME/draw.en.htm">http://biomodel.uah.es/en/DIY/JSME/draw.en.htm</a></p><p>The system was built with <a href="http://m3g.iqm.unicamp.br/packmol">Packmol</a>.</p><p>The simulations were perfomed with <a href="https://www.ks.uiuc.edu/Research/namd/">NAMD</a>, with <a href="https://www.charmm.org">CHARMM36</a> parameters. </p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../example1/">« ◦ Protein in water/glycerol</a><a class="docs-footer-nextpage" href="../example3/">◦ POPC membrane in water/ethanol »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Monday 5 August 2024 20:02">Monday 5 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</center><h3 id="References"><a class="docs-heading-anchor" href="#References">References</a><a id="References-1"></a><a class="docs-heading-anchor-permalink" href="#References" title="Permalink"></a></h3><p>Molecules built with JSME: B. Bienfait and P. Ertl, JSME: a free molecule editor in JavaScript, Journal of Cheminformatics 5:24 (2013) <a href="http://biomodel.uah.es/en/DIY/JSME/draw.en.htm">http://biomodel.uah.es/en/DIY/JSME/draw.en.htm</a></p><p>The system was built with <a href="http://m3g.iqm.unicamp.br/packmol">Packmol</a>.</p><p>The simulations were perfomed with <a href="https://www.ks.uiuc.edu/Research/namd/">NAMD</a>, with <a href="https://www.charmm.org">CHARMM36</a> parameters. </p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../example1/">« ◦ Protein in water/glycerol</a><a class="docs-footer-nextpage" href="../example3/">◦ POPC membrane in water/ethanol »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Monday 5 August 2024 20:43">Monday 5 August 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>