lattice/pyerrors
1
0
Fork 0
mirror of https://github.com/fjosw/pyerrors.git synced 2025-06-30 16:59:27 +02:00
Code Issues Projects Releases Packages Wiki Activity

Documentation updated

Browse source
This commit is contained in:
fjosw 2023-01-03 10:01:33 +00:00
parent 849c12a78e
commit d85fbddcdf
18 changed files with 324 additions and 324 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/pyerrors/input/pandas.html
View file

@ -95,7 +95,7 @@
</span><span id="L-8"><a href="#L-8"><span class="linenos"> 8</span></a>
</span><span id="L-9"><a href="#L-9"><span class="linenos"> 9</span></a>
</span><span id="L-10"><a href="#L-10"><span class="linenos"> 10</span></a><span class="k">def</span> <span class="nf">to_sql</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">table_name</span><span class="p">,</span> <span class="n">db</span><span class="p">,</span> <span class="n">if_exists</span><span class="o">=</span><span class="s1">&#39;fail&#39;</span><span class="p">,</span> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
</span><span id="L-11"><a href="#L-11"><span class="linenos"> 11</span></a> <span class="sd">&quot;&quot;&quot;Write DataFrame including Obs or Corr valued columns to sqlite database.</span>
</span><span id="L-11"><a href="#L-11"><span class="linenos"> 11</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Write DataFrame including Obs or Corr valued columns to sqlite database.</span>
</span><span id="L-12"><a href="#L-12"><span class="linenos"> 12</span></a>
</span><span id="L-13"><a href="#L-13"><span class="linenos"> 13</span></a><span class="sd"> Parameters</span>
</span><span id="L-14"><a href="#L-14"><span class="linenos"> 14</span></a><span class="sd"> ----------</span>
@ -117,7 +117,7 @@
</span><span id="L-30"><a href="#L-30"><span class="linenos"> 30</span></a>
</span><span id="L-31"><a href="#L-31"><span class="linenos"> 31</span></a>
</span><span id="L-32"><a href="#L-32"><span class="linenos"> 32</span></a><span class="k">def</span> <span class="nf">read_sql</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">db</span><span class="p">,</span> <span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
</span><span id="L-33"><a href="#L-33"><span class="linenos"> 33</span></a> <span class="sd">&quot;&quot;&quot;Execute SQL query on sqlite database and obtain DataFrame including Obs or Corr valued columns.</span>
</span><span id="L-33"><a href="#L-33"><span class="linenos"> 33</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Execute SQL query on sqlite database and obtain DataFrame including Obs or Corr valued columns.</span>
</span><span id="L-34"><a href="#L-34"><span class="linenos"> 34</span></a>
</span><span id="L-35"><a href="#L-35"><span class="linenos"> 35</span></a><span class="sd"> Parameters</span>
</span><span id="L-36"><a href="#L-36"><span class="linenos"> 36</span></a><span class="sd"> ----------</span>
@ -136,7 +136,7 @@
</span><span id="L-49"><a href="#L-49"><span class="linenos"> 49</span></a>
</span><span id="L-50"><a href="#L-50"><span class="linenos"> 50</span></a>
</span><span id="L-51"><a href="#L-51"><span class="linenos"> 51</span></a><span class="k">def</span> <span class="nf">dump_df</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">fname</span><span class="p">,</span> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
</span><span id="L-52"><a href="#L-52"><span class="linenos"> 52</span></a> <span class="sd">&quot;&quot;&quot;Exports a pandas DataFrame containing Obs valued columns to a (gzipped) csv file.</span>
</span><span id="L-52"><a href="#L-52"><span class="linenos"> 52</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Exports a pandas DataFrame containing Obs valued columns to a (gzipped) csv file.</span>
</span><span id="L-53"><a href="#L-53"><span class="linenos"> 53</span></a>
</span><span id="L-54"><a href="#L-54"><span class="linenos"> 54</span></a><span class="sd"> Before making use of pandas to_csv functionality Obs objects are serialized via the standardized</span>
</span><span id="L-55"><a href="#L-55"><span class="linenos"> 55</span></a><span class="sd"> json format of pyerrors.</span>
@ -164,7 +164,7 @@
</span><span id="L-77"><a href="#L-77"><span class="linenos"> 77</span></a>
</span><span id="L-78"><a href="#L-78"><span class="linenos"> 78</span></a>
</span><span id="L-79"><a href="#L-79"><span class="linenos"> 79</span></a><span class="k">def</span> <span class="nf">load_df</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
</span><span id="L-80"><a href="#L-80"><span class="linenos"> 80</span></a> <span class="sd">&quot;&quot;&quot;Imports a pandas DataFrame from a csv.(gz) file in which Obs objects are serialized as json strings.</span>
</span><span id="L-80"><a href="#L-80"><span class="linenos"> 80</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Imports a pandas DataFrame from a csv.(gz) file in which Obs objects are serialized as json strings.</span>
</span><span id="L-81"><a href="#L-81"><span class="linenos"> 81</span></a>
</span><span id="L-82"><a href="#L-82"><span class="linenos"> 82</span></a><span class="sd"> Parameters</span>
</span><span id="L-83"><a href="#L-83"><span class="linenos"> 83</span></a><span class="sd"> ----------</span>
@ -193,7 +193,7 @@
</span><span id="L-106"><a href="#L-106"><span class="linenos">106</span></a>
</span><span id="L-107"><a href="#L-107"><span class="linenos">107</span></a>
</span><span id="L-108"><a href="#L-108"><span class="linenos">108</span></a><span class="k">def</span> <span class="nf">_serialize_df</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">gz</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
</span><span id="L-109"><a href="#L-109"><span class="linenos">109</span></a> <span class="sd">&quot;&quot;&quot;Serializes all Obs or Corr valued columns into json strings according to the pyerrors json specification.</span>
</span><span id="L-109"><a href="#L-109"><span class="linenos">109</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Serializes all Obs or Corr valued columns into json strings according to the pyerrors json specification.</span>
</span><span id="L-110"><a href="#L-110"><span class="linenos">110</span></a>
</span><span id="L-111"><a href="#L-111"><span class="linenos">111</span></a><span class="sd"> Parameters</span>
</span><span id="L-112"><a href="#L-112"><span class="linenos">112</span></a><span class="sd"> ----------</span>
@ -212,7 +212,7 @@
</span><span id="L-125"><a href="#L-125"><span class="linenos">125</span></a>
</span><span id="L-126"><a href="#L-126"><span class="linenos">126</span></a>
</span><span id="L-127"><a href="#L-127"><span class="linenos">127</span></a><span class="k">def</span> <span class="nf">_deserialize_df</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
</span><span id="L-128"><a href="#L-128"><span class="linenos">128</span></a> <span class="sd">&quot;&quot;&quot;Deserializes all pyerrors json strings into Obs or Corr objects according to the pyerrors json specification.</span>
</span><span id="L-128"><a href="#L-128"><span class="linenos">128</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Deserializes all pyerrors json strings into Obs or Corr objects according to the pyerrors json specification.</span>
</span><span id="L-129"><a href="#L-129"><span class="linenos">129</span></a>
</span><span id="L-130"><a href="#L-130"><span class="linenos">130</span></a><span class="sd"> Parameters</span>
</span><span id="L-131"><a href="#L-131"><span class="linenos">131</span></a><span class="sd"> ----------</span>
@ -252,7 +252,7 @@
</div>
<a class="headerlink" href="#to_sql"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="to_sql-11"><a href="#to_sql-11"><span class="linenos">11</span></a><span class="k">def</span> <span class="nf">to_sql</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">table_name</span><span class="p">,</span> <span class="n">db</span><span class="p">,</span> <span class="n">if_exists</span><span class="o">=</span><span class="s1">&#39;fail&#39;</span><span class="p">,</span> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
</span><span id="to_sql-12"><a href="#to_sql-12"><span class="linenos">12</span></a> <span class="sd">&quot;&quot;&quot;Write DataFrame including Obs or Corr valued columns to sqlite database.</span>
</span><span id="to_sql-12"><a href="#to_sql-12"><span class="linenos">12</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Write DataFrame including Obs or Corr valued columns to sqlite database.</span>
</span><span id="to_sql-13"><a href="#to_sql-13"><span class="linenos">13</span></a>
</span><span id="to_sql-14"><a href="#to_sql-14"><span class="linenos">14</span></a><span class="sd"> Parameters</span>
</span><span id="to_sql-15"><a href="#to_sql-15"><span class="linenos">15</span></a><span class="sd"> ----------</span>
@ -306,7 +306,7 @@ If True the json strings are gzipped.</li>
</div>
<a class="headerlink" href="#read_sql"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="read_sql-33"><a href="#read_sql-33"><span class="linenos">33</span></a><span class="k">def</span> <span class="nf">read_sql</span><span class="p">(</span><span class="n">sql</span><span class="p">,</span> <span class="n">db</span><span class="p">,</span> <span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
</span><span id="read_sql-34"><a href="#read_sql-34"><span class="linenos">34</span></a> <span class="sd">&quot;&quot;&quot;Execute SQL query on sqlite database and obtain DataFrame including Obs or Corr valued columns.</span>
</span><span id="read_sql-34"><a href="#read_sql-34"><span class="linenos">34</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Execute SQL query on sqlite database and obtain DataFrame including Obs or Corr valued columns.</span>
</span><span id="read_sql-35"><a href="#read_sql-35"><span class="linenos">35</span></a>
</span><span id="read_sql-36"><a href="#read_sql-36"><span class="linenos">36</span></a><span class="sd"> Parameters</span>
</span><span id="read_sql-37"><a href="#read_sql-37"><span class="linenos">37</span></a><span class="sd"> ----------</span>
@ -354,7 +354,7 @@ the error analysis. Default False.</li>
</div>
<a class="headerlink" href="#dump_df"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="dump_df-52"><a href="#dump_df-52"><span class="linenos">52</span></a><span class="k">def</span> <span class="nf">dump_df</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">fname</span><span class="p">,</span> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
</span><span id="dump_df-53"><a href="#dump_df-53"><span class="linenos">53</span></a> <span class="sd">&quot;&quot;&quot;Exports a pandas DataFrame containing Obs valued columns to a (gzipped) csv file.</span>
</span><span id="dump_df-53"><a href="#dump_df-53"><span class="linenos">53</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Exports a pandas DataFrame containing Obs valued columns to a (gzipped) csv file.</span>
</span><span id="dump_df-54"><a href="#dump_df-54"><span class="linenos">54</span></a>
</span><span id="dump_df-55"><a href="#dump_df-55"><span class="linenos">55</span></a><span class="sd"> Before making use of pandas to_csv functionality Obs objects are serialized via the standardized</span>
</span><span id="dump_df-56"><a href="#dump_df-56"><span class="linenos">56</span></a><span class="sd"> json format of pyerrors.</span>
@ -413,7 +413,7 @@ If True, the output is a gzipped csv file. If False, the output is a csv file.</
</div>
<a class="headerlink" href="#load_df"></a>
<div class="pdoc-code codehilite"><pre><span></span><span id="load_df-80"><a href="#load_df-80"><span class="linenos"> 80</span></a><span class="k">def</span> <span class="nf">load_df</span><span class="p">(</span><span class="n">fname</span><span class="p">,</span> <span class="n">auto_gamma</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">gz</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
</span><span id="load_df-81"><a href="#load_df-81"><span class="linenos"> 81</span></a> <span class="sd">&quot;&quot;&quot;Imports a pandas DataFrame from a csv.(gz) file in which Obs objects are serialized as json strings.</span>
</span><span id="load_df-81"><a href="#load_df-81"><span class="linenos"> 81</span></a><span class="w"> </span><span class="sd">&quot;&quot;&quot;Imports a pandas DataFrame from a csv.(gz) file in which Obs objects are serialized as json strings.</span>
</span><span id="load_df-82"><a href="#load_df-82"><span class="linenos"> 82</span></a>
</span><span id="load_df-83"><a href="#load_df-83"><span class="linenos"> 83</span></a><span class="sd"> Parameters</span>
</span><span id="load_df-84"><a href="#load_df-84"><span class="linenos"> 84</span></a><span class="sd"> ----------</span>