Update documentation

LBC-LNBio · Jun 11, 2024 · 9961c75 · 9961c75 · github-actions · Jun 11, 2024
1 parent 20d854d
commit 9961c75
Show file tree

Hide file tree

Showing 75 changed files with 1,130 additions and 702 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 7ebda328a51f5481e12e6a0a4aa0acb7
+config: 5e67e5b08739af2cbadbbffeab3c7d4f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/_about/index.doctree b/docs/.doctrees/_about/index.doctree
diff --git a/docs/.doctrees/_api_reference/Molecule.doctree b/docs/.doctrees/_api_reference/Molecule.doctree
diff --git a/docs/.doctrees/_api_reference/calculate_frequencies.doctree b/docs/.doctrees/_api_reference/calculate_frequencies.doctree
diff --git a/docs/.doctrees/_api_reference/constitutional.doctree b/docs/.doctrees/_api_reference/constitutional.doctree
diff --git a/docs/.doctrees/_api_reference/depth.doctree b/docs/.doctrees/_api_reference/depth.doctree
diff --git a/docs/.doctrees/_api_reference/detect.doctree b/docs/.doctrees/_api_reference/detect.doctree
diff --git a/docs/.doctrees/_api_reference/export.doctree b/docs/.doctrees/_api_reference/export.doctree
diff --git a/docs/.doctrees/_api_reference/export_openings.doctree b/docs/.doctrees/_api_reference/export_openings.doctree
diff --git a/docs/.doctrees/_api_reference/get_vertices.doctree b/docs/.doctrees/_api_reference/get_vertices.doctree
diff --git a/docs/.doctrees/_api_reference/get_vertices_from_file.doctree b/docs/.doctrees/_api_reference/get_vertices_from_file.doctree
diff --git a/docs/.doctrees/_api_reference/hydropathy.doctree b/docs/.doctrees/_api_reference/hydropathy.doctree
diff --git a/docs/.doctrees/_api_reference/index.doctree b/docs/.doctrees/_api_reference/index.doctree
diff --git a/docs/.doctrees/_api_reference/openings.doctree b/docs/.doctrees/_api_reference/openings.doctree
diff --git a/docs/.doctrees/_api_reference/plot_frequencies.doctree b/docs/.doctrees/_api_reference/plot_frequencies.doctree
diff --git a/docs/.doctrees/_api_reference/pyKVFinderResults.doctree b/docs/.doctrees/_api_reference/pyKVFinderResults.doctree
diff --git a/docs/.doctrees/_api_reference/read_cavity.doctree b/docs/.doctrees/_api_reference/read_cavity.doctree
diff --git a/docs/.doctrees/_api_reference/read_pdb.doctree b/docs/.doctrees/_api_reference/read_pdb.doctree
diff --git a/docs/.doctrees/_api_reference/read_vdw.doctree b/docs/.doctrees/_api_reference/read_vdw.doctree
diff --git a/docs/.doctrees/_api_reference/read_xyz.doctree b/docs/.doctrees/_api_reference/read_xyz.doctree
diff --git a/docs/.doctrees/_api_reference/run_workflow.doctree b/docs/.doctrees/_api_reference/run_workflow.doctree
diff --git a/docs/.doctrees/_api_reference/spatial.doctree b/docs/.doctrees/_api_reference/spatial.doctree
diff --git a/docs/.doctrees/_api_reference/write_results.doctree b/docs/.doctrees/_api_reference/write_results.doctree
diff --git a/docs/.doctrees/_cfg_files/box_file_template.doctree b/docs/.doctrees/_cfg_files/box_file_template.doctree
diff --git a/docs/.doctrees/_cfg_files/hydrophobicity_scale_file_template.doctree b/docs/.doctrees/_cfg_files/hydrophobicity_scale_file_template.doctree
diff --git a/docs/.doctrees/_cfg_files/vdw_file_template.doctree b/docs/.doctrees/_cfg_files/vdw_file_template.doctree
diff --git a/docs/.doctrees/_cli/index.doctree b/docs/.doctrees/_cli/index.doctree
diff --git a/docs/.doctrees/_installation/index.doctree b/docs/.doctrees/_installation/index.doctree
diff --git a/docs/.doctrees/_tutorial/index.doctree b/docs/.doctrees/_tutorial/index.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/_about/index.html b/docs/_about/index.html
@@ -1,21 +1,24 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="../">
 <head>
-  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Issues &mdash; pyKVFinder 0.6.13 documentation</title>
-      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <title>Issues &mdash; pyKVFinder 0.6.14 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
     <link rel="shortcut icon" href="../_static/icon.ico"/>
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-        <script src="../_static/doctools.js"></script>
-        <script src="../_static/sphinx_highlight.js"></script>
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=3ad970d1"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -110,7 +113,7 @@
            <div itemprop="articleBody">
 
   <h1>About</h1><section id="issues">
-<h1>Issues<a class="headerlink" href="#issues" title="Permalink to this heading"></a></h1>
+<h1>Issues<a class="headerlink" href="#issues" title="Link to this heading"></a></h1>
 <p>pyKVFinder package uses GitHub for project management. Please help us by reporting any problems or requests.</p>
 <p>On <a class="reference external" href="https://github.com/LBC-LNBio/pyKVFinder/issues">Issues</a> page, you can file a:</p>
 <div class="toctree-wrapper compound">
@@ -123,7 +126,7 @@ <h1>Issues<a class="headerlink" href="#issues" title="Permalink to this heading"
 <p>Thank you for helping us improve pyKVFinder!</p>
 </section>
 <section id="scientific-team">
-<h1>Scientific team<a class="headerlink" href="#scientific-team" title="Permalink to this heading"></a></h1>
+<h1>Scientific team<a class="headerlink" href="#scientific-team" title="Link to this heading"></a></h1>
 <p>pyKVFinder was developed by:</p>
 <ul class="simple">
 <li><p>João Victor da Silva Guerra</p></li>
@@ -137,18 +140,18 @@ <h1>Scientific team<a class="headerlink" href="#scientific-team" title="Permalin
 <p>If you have any further questions, inquires or if you wish to contribute to KVFinder project, please contact us at <a class="reference external" href="mailto:joao&#46;guerra&#37;&#52;&#48;lnbio&#46;cnpem&#46;br">joao<span>&#46;</span>guerra<span>&#64;</span>lnbio<span>&#46;</span>cnpem<span>&#46;</span>br</a> or <a class="reference external" href="mailto:paulo&#46;oliveira&#37;&#52;&#48;lnbio&#46;cnpem&#46;br">paulo<span>&#46;</span>oliveira<span>&#64;</span>lnbio<span>&#46;</span>cnpem<span>&#46;</span>br</a>.</p>
 </section>
 <section id="citing-pykvfinder">
-<h1>Citing pyKVFinder<a class="headerlink" href="#citing-pykvfinder" title="Permalink to this heading"></a></h1>
+<h1>Citing pyKVFinder<a class="headerlink" href="#citing-pykvfinder" title="Link to this heading"></a></h1>
 <p>If you use pyKVFinder package, please cite:</p>
 <p>Guerra, J. V. S., Ribeiro-Filho, H. V., Jara, G. E., Bortot, L. O., Pereira, J. G. C., &amp; Lopes-de-Oliveira, P. S. (2021). pyKVFinder: an efficient and integrable Python package for biomolecular cavity detection and characterization in data science. BMC bioinformatics, 22(1), 607. <a class="reference external" href="https://doi.org/10.1186/s12859-021-04519-4">https://doi.org/10.1186/s12859-021-04519-4</a>.</p>
 <p>If you use <cite>pyKVFinder.Molecule</cite>, please also cite:</p>
 <p>Guerra, J. V. S., Alves, L. F. G., Bourissou, D., Lopes-de-Oliveira, P. S., &amp; Szalóki, G. (2023). Cavity Characterization in Supramolecular Cages. Journal of chemical information and modeling, 63(12), 3772-3785. <a class="reference external" href="https://doi.org/10.1021/acs.jcim.3c00328">https://doi.org/10.1021/acs.jcim.3c00328</a>.</p>
 </section>
 <section id="funding">
-<h1>Funding<a class="headerlink" href="#funding" title="Permalink to this heading"></a></h1>
+<h1>Funding<a class="headerlink" href="#funding" title="Link to this heading"></a></h1>
 <p>This work was supported by the Fundação de Amparo à Pesquisa do Estado de São Paulo (FAPESP) [Grant Number 2018/00629-0], Conselho Nacional de Desenvolvimento Científico e Tecnológico (CNPq) [Grant Number 350244/2020-0], and Brazilian Center for Research in Energy and Materials (CNPEM).</p>
 </section>
 <section id="license">
-<h1>License<a class="headerlink" href="#license" title="Permalink to this heading"></a></h1>
+<h1>License<a class="headerlink" href="#license" title="Link to this heading"></a></h1>
 <p>The software is licensed under the terms of the GNU General Public License version 3 (GPL3) and is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
 </section>
File	Stmts	Miss	Cover	Missing
pyKVFinder
grid.py	729	112	85%	918, 922, 2243–2263, 2400–2477, 2749–2766, 2867–2936
main.py	361	69	81%	93, 97, 105, 114, 142–148, 495, 660, 1061, 1068, 1078, 1089, 1108, 1113–1114, 1340, 1345, 1351, 1358, 1361–1364, 1368–1373, 1385, 1395, 1424–1425, 1430–1431, 1436–1437, 1497–1502, 1508, 1513–1518, 1578, 1580, 1593, 1704, 1706, 1712, 1714, 1720, 1725, 1729, 1782–1792, 1818
utils.py	312	6	98%	571, 603, 606–608, 630
TOTAL	1402	187	87%