Skip to content

Commit d2f8e5b

Browse files
hamidrezaghafouri-hubhamidrezaghafouri-hub
committed
update docs
1 parent 167b165 commit d2f8e5b

160 files changed

Lines changed: 30693 additions & 2724 deletions

File tree

Some content is hidden

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

‎docs/.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 records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 6726f5f8fc50df4528e8b63e24d89531
3+
config: 72ad0973e0b5dcc525ec489f7f0f0504
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/.buildinfo.bak‎

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 records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 405ddcd058df63d7ae9369f874302c8f
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/Global_analysis.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@
99
<title>Global analysis &mdash; IDPET 0.1.0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
12+
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
1213

1314

1415
<script src="_static/jquery.js?v=5d32c60e"></script>
1516
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
1617
<script src="_static/documentation_options.js?v=01f34227"></script>
1718
<script src="_static/doctools.js?v=9bcbadda"></script>
1819
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
20+
<script src="_static/design-tabs.js?v=f930bc37"></script>
1921
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
2022
<script src="_static/js/theme.js"></script>
2123
<link rel="index" title="Index" href="genindex.html" />
@@ -110,9 +112,9 @@ <h1>Global analysis<a class="headerlink" href="#global-analysis" title="Link to
110112
</ul>
111113
<section id="initialize-the-analysis">
112114
<h2>Initialize the analysis<a class="headerlink" href="#initialize-the-analysis" title="Link to this heading"></a></h2>
113-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">dpet.ensemble</span><span class="w"> </span><span class="kn">import</span> <span class="n">Ensemble</span>
114-
<span class="kn">from</span><span class="w"> </span><span class="nn">dpet.ensemble_analysis</span><span class="w"> </span><span class="kn">import</span> <span class="n">EnsembleAnalysis</span>
115-
<span class="kn">from</span><span class="w"> </span><span class="nn">dpet.visualization</span><span class="w"> </span><span class="kn">import</span> <span class="n">Visualization</span>
115+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">idpet.ensemble</span><span class="w"> </span><span class="kn">import</span> <span class="n">Ensemble</span>
116+
<span class="kn">from</span><span class="w"> </span><span class="nn">idpet.ensemble_analysis</span><span class="w"> </span><span class="kn">import</span> <span class="n">EnsembleAnalysis</span>
117+
<span class="kn">from</span><span class="w"> </span><span class="nn">idpet.visualization</span><span class="w"> </span><span class="kn">import</span> <span class="n">Visualization</span>
116118

117119
<span class="n">ensembles</span> <span class="o">=</span> <span class="p">[</span>
118120
<span class="n">Ensemble</span><span class="p">(</span><span class="s1">&#39;PED00156e001&#39;</span><span class="p">,</span> <span class="n">database</span><span class="o">=</span><span class="s1">&#39;ped&#39;</span><span class="p">),</span> <span class="c1">#The ensemble derived from Random pool</span>

‎docs/_images/three_scores.png‎

-9.52 KB
Loading

‎docs/_modules/idpet/comparison.html‎

Lines changed: 1347 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/idpet/coord.html‎

Lines changed: 287 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/idpet/data/api_client.html‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" data-content_root="../../../">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>idpet.data.api_client &mdash; IDPET 0.1.0 documentation</title>
9+
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=b86133f3" />
10+
<link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
11+
12+
13+
<script src="../../../_static/jquery.js?v=5d32c60e"></script>
14+
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15+
<script src="../../../_static/documentation_options.js?v=01f34227"></script>
16+
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
17+
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
18+
<script src="../../../_static/js/theme.js"></script>
19+
<link rel="index" title="Index" href="../../../genindex.html" />
20+
<link rel="search" title="Search" href="../../../search.html" />
21+
</head>
22+
23+
<body class="wy-body-for-nav">
24+
<div class="wy-grid-for-nav">
25+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
26+
<div class="wy-side-scroll">
27+
<div class="wy-side-nav-search" >
28+
29+
30+
31+
<a href="../../../index.html" class="icon icon-home">
32+
IDPET
33+
</a>
34+
<div role="search">
35+
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
36+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
37+
<input type="hidden" name="check_keywords" value="yes" />
38+
<input type="hidden" name="area" value="default" />
39+
</form>
40+
</div>
41+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
42+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
43+
<ul>
44+
<li class="toctree-l1"><a class="reference internal" href="../../../overview.html">Overview</a></li>
45+
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
46+
<li class="toctree-l1"><a class="reference internal" href="../../../demo.html">Demo</a></li>
47+
<li class="toctree-l1"><a class="reference internal" href="../../../ensemble_analysis.html">ensemble_analysis</a></li>
48+
<li class="toctree-l1"><a class="reference internal" href="../../../ensemble.html">ensemble</a></li>
49+
<li class="toctree-l1"><a class="reference internal" href="../../../visualization.html">visualization</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="../../../comparison.html">ensemble_compariosn</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">dpet</a></li>
52+
</ul>
53+
54+
</div>
55+
</div>
56+
</nav>
57+
58+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
59+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
60+
<a href="../../../index.html">IDPET</a>
61+
</nav>
62+
63+
<div class="wy-nav-content">
64+
<div class="rst-content">
65+
<div role="navigation" aria-label="Page navigation">
66+
<ul class="wy-breadcrumbs">
67+
<li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
68+
<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
69+
<li class="breadcrumb-item active">idpet.data.api_client</li>
70+
<li class="wy-breadcrumbs-aside">
71+
</li>
72+
</ul>
73+
<hr/>
74+
</div>
75+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
76+
<div itemprop="articleBody">
77+
78+
<h1>Source code for idpet.data.api_client</h1><div class="highlight"><pre>
79+
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
80+
<span class="kn">from</span><span class="w"> </span><span class="nn">idpet.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
81+
82+
83+
<div class="viewcode-block" id="APIClient">
84+
<a class="viewcode-back" href="../../../dpet.data.html#idpet.data.api_client.APIClient">[docs]</a>
85+
<span class="k">class</span><span class="w"> </span><span class="nc">APIClient</span><span class="p">:</span>
86+
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
87+
<span class="bp">self</span><span class="o">.</span><span class="n">session</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">()</span>
88+
89+
<div class="viewcode-block" id="APIClient.perform_get_request">
90+
<a class="viewcode-back" href="../../../dpet.data.html#idpet.data.api_client.APIClient.perform_get_request">[docs]</a>
91+
<span class="k">def</span><span class="w"> </span><span class="nf">perform_get_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
92+
<span class="k">try</span><span class="p">:</span>
93+
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
94+
<span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span> <span class="c1"># Raise an exception for HTTP errors</span>
95+
<span class="k">return</span> <span class="n">response</span>
96+
<span class="k">except</span> <span class="n">requests</span><span class="o">.</span><span class="n">RequestException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
97+
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error during GET request: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
98+
<span class="k">return</span> <span class="kc">None</span></div>
99+
100+
101+
<div class="viewcode-block" id="APIClient.download_response_content">
102+
<a class="viewcode-back" href="../../../dpet.data.html#idpet.data.api_client.APIClient.download_response_content">[docs]</a>
103+
<span class="k">def</span><span class="w"> </span><span class="nf">download_response_content</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">,</span> <span class="n">save_path</span><span class="p">):</span>
104+
<span class="k">try</span><span class="p">:</span>
105+
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">save_path</span><span class="p">,</span> <span class="s1">&#39;wb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
106+
<span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">iter_content</span><span class="p">(</span><span class="n">chunk_size</span><span class="o">=</span><span class="mi">8192</span><span class="p">):</span>
107+
<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
108+
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Download complete. Saved to: </span><span class="si">{</span><span class="n">save_path</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
109+
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
110+
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Error during content download: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>
111+
112+
113+
<div class="viewcode-block" id="APIClient.close_session">
114+
<a class="viewcode-back" href="../../../dpet.data.html#idpet.data.api_client.APIClient.close_session">[docs]</a>
115+
<span class="k">def</span><span class="w"> </span><span class="nf">close_session</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
116+
<span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div>
117+
</div>
118+
119+
120+
</pre></div>
121+
122+
</div>
123+
</div>
124+
<footer>
125+
126+
<hr/>
127+
128+
<div role="contentinfo">
129+
<p>&#169; Copyright 2025, Hamidreza Ghafouri, Giacomo Janson, Silvio C.E. Tosatto, Alexander Miguel Monzon.</p>
130+
</div>
131+
132+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
133+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
134+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
135+
136+
137+
</footer>
138+
</div>
139+
</div>
140+
</section>
141+
</div>
142+
<script>
143+
jQuery(function () {
144+
SphinxRtdTheme.Navigation.enable(true);
145+
});
146+
</script>
147+
148+
</body>
149+
</html>

0 commit comments

Comments
 (0)