Skip to content

Commit

Permalink
deploy: 96b3e9a
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterKraus committed May 24, 2024
1 parent 7a45f44 commit d6becba
Show file tree
Hide file tree
Showing 14 changed files with 31 additions and 32 deletions.
Binary file modified master/.doctrees/apidoc/yadg.extractors.eclab.common.doctree
Binary file not shown.
Binary file modified master/.doctrees/apidoc/yadg.extractors.eclab.doctree
Binary file not shown.
Binary file modified master/.doctrees/environment.pickle
Binary file not shown.
Binary file modified master/.doctrees/version.5_1.doctree
Binary file not shown.
Binary file modified master/.doctrees/version.doctree
Binary file not shown.
3 changes: 2 additions & 1 deletion master/_sources/version.5_1.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Bug fixes in ``yadg-5.1`` include:
- Fixed incorrect parsing of units in the :mod:`yadg.extractors.ezchrom.asc` parser. Now, the ``25 μV`` unit will be correctly replaced by just ``μV`` (without modifying data), which can be understood by :mod:`pint`.
- Added several new I-range values to :mod:`yadg.extractors.eclab` parsers. Now, I-range values up to 130 are supported.
- Fixed incorrect column name (``Energy`` to ``|Energy|``) in :mod:`yadg.extractors.eclab.mpr`.
- Removed column renaming for ``Analog IN 1`` and ``Analog IN 2`` to maintain consistency within :mod:`yadg.extractors.eclab`
- Removed column renaming for ``Analog IN 1`` and ``Analog IN 2`` to maintain consistency within :mod:`yadg.extractors.eclab`.
- Reworked parsing of ``.mpt`` file headers in :mod:`yadg.extractors.eclab.mpt`. The parser is now more stable, and the original labels are used without renaming.

.. _concat_lab: https://tu.berlin/en/concat

Expand Down
22 changes: 0 additions & 22 deletions master/apidoc/yadg.extractors.eclab.common.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@
<li class="toctree-l2"><a class="reference internal" href="#module-yadg.extractors.eclab.common.mpt_columns">yadg.extractors.eclab.common.mpt_columns module</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-yadg.extractors.eclab.common.techniques">yadg.extractors.eclab.common.techniques module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#eclabtechniques-parameters-for-implemented-techniques"><strong>eclabtechniques</strong>: Parameters for implemented techniques.</a></li>
<li class="toctree-l3"><a class="reference internal" href="#yadg.extractors.eclab.common.techniques.technique_params"><code class="docutils literal notranslate"><span class="pre">technique_params()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#yadg.extractors.eclab.common.techniques.param_from_key"><code class="docutils literal notranslate"><span class="pre">param_from_key()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#yadg.extractors.eclab.common.techniques.get_resolution"><code class="docutils literal notranslate"><span class="pre">get_resolution()</span></code></a></li>
</ul>
Expand Down Expand Up @@ -149,27 +148,6 @@ <h3><strong>eclabtechniques</strong>: Parameters for implemented techniques.<a c
<p>The module also implements resolution determination for parameters of techniques,
in <a class="reference internal" href="#yadg.extractors.eclab.common.techniques.get_resolution" title="yadg.extractors.eclab.common.techniques.get_resolution"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_resolution()</span></code></a>.</p>
</section>
<dl class="py function">
<dt class="sig sig-object py" id="yadg.extractors.eclab.common.techniques.technique_params">
<span class="sig-prename descclassname"><span class="pre">yadg.extractors.eclab.common.techniques.</span></span><span class="sig-name descname"><span class="pre">technique_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">technique</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#yadg.extractors.eclab.common.techniques.technique_params" title="Link to this definition"></a></dt>
<dd><p>Constructs the parameter names for different techniques.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>technique</strong> – The full name of the technique.</p></li>
<li><p><strong>settings</strong> – The list of settings from the start of an .mpt or .mps file.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The short technique name and a full list of technique parameter
names depending on what is present in the file.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple[str, list]</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="yadg.extractors.eclab.common.techniques.param_from_key">
<span class="sig-prename descclassname"><span class="pre">yadg.extractors.eclab.common.techniques.</span></span><span class="sig-name descname"><span class="pre">param_from_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">param</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_str</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></span></span><a class="headerlink" href="#yadg.extractors.eclab.common.techniques.param_from_key" title="Link to this definition"></a></dt>
Expand Down
16 changes: 14 additions & 2 deletions master/apidoc/yadg.extractors.eclab.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@
<li class="toctree-l3"><a class="reference internal" href="#id2">Schema</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id3">Notes on file structure</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">Metadata</a></li>
<li class="toctree-l3"><a class="reference internal" href="#yadg.extractors.eclab.mpt.process_settings"><code class="docutils literal notranslate"><span class="pre">process_settings()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#yadg.extractors.eclab.mpt.process_params"><code class="docutils literal notranslate"><span class="pre">process_params()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#yadg.extractors.eclab.mpt.process_header"><code class="docutils literal notranslate"><span class="pre">process_header()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#yadg.extractors.eclab.mpt.process_data"><code class="docutils literal notranslate"><span class="pre">process_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#yadg.extractors.eclab.mpt.extract"><code class="docutils literal notranslate"><span class="pre">extract()</span></code></a></li>
Expand Down Expand Up @@ -153,7 +155,6 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l2"><a class="reference internal" href="yadg.extractors.eclab.common.html#module-yadg.extractors.eclab.common.mpt_columns">yadg.extractors.eclab.common.mpt_columns module</a></li>
<li class="toctree-l2"><a class="reference internal" href="yadg.extractors.eclab.common.html#module-yadg.extractors.eclab.common.techniques">yadg.extractors.eclab.common.techniques module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.common.html#eclabtechniques-parameters-for-implemented-techniques"><strong>eclabtechniques</strong>: Parameters for implemented techniques.</a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.common.html#yadg.extractors.eclab.common.techniques.technique_params"><code class="docutils literal notranslate"><span class="pre">technique_params()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.common.html#yadg.extractors.eclab.common.techniques.param_from_key"><code class="docutils literal notranslate"><span class="pre">param_from_key()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.common.html#yadg.extractors.eclab.common.techniques.get_resolution"><code class="docutils literal notranslate"><span class="pre">get_resolution()</span></code></a></li>
</ul>
Expand Down Expand Up @@ -647,8 +648,19 @@ <h3>Metadata<a class="headerlink" href="#id4" title="Link to this heading"></
<p>The mapping between metadata parameters between <code class="docutils literal notranslate"><span class="pre">.mpr</span></code> and <code class="docutils literal notranslate"><span class="pre">.mpt</span></code> files
is not yet complete.</p>
</div>
<p><em>Code author: Nicolas Vetsch</em></p>
<p><em>Code author: Nicolas Vetsch,
Peter Kraus</em></p>
</section>
<dl class="py function">
<dt class="sig sig-object py" id="yadg.extractors.eclab.mpt.process_settings">
<span class="sig-prename descclassname"><span class="pre">yadg.extractors.eclab.mpt.</span></span><span class="sig-name descname"><span class="pre">process_settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lines</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#yadg.extractors.eclab.mpt.process_settings" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="yadg.extractors.eclab.mpt.process_params">
<span class="sig-prename descclassname"><span class="pre">yadg.extractors.eclab.mpt.</span></span><span class="sig-name descname"><span class="pre">process_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">technique</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lines</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#yadg.extractors.eclab.mpt.process_params" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="yadg.extractors.eclab.mpt.process_header">
<span class="sig-prename descclassname"><span class="pre">yadg.extractors.eclab.mpt.</span></span><span class="sig-name descname"><span class="pre">process_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">lines</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timezone</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">locale</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#yadg.extractors.eclab.mpt.process_header" title="Link to this definition"></a></dt>
Expand Down
2 changes: 2 additions & 0 deletions master/apidoc/yadg.extractors.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,8 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.html#id2">Schema</a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.html#id3">Notes on file structure</a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.html#id4">Metadata</a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.html#yadg.extractors.eclab.mpt.process_settings"><code class="docutils literal notranslate"><span class="pre">process_settings()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.html#yadg.extractors.eclab.mpt.process_params"><code class="docutils literal notranslate"><span class="pre">process_params()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.html#yadg.extractors.eclab.mpt.process_header"><code class="docutils literal notranslate"><span class="pre">process_header()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.html#yadg.extractors.eclab.mpt.process_data"><code class="docutils literal notranslate"><span class="pre">process_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="yadg.extractors.eclab.html#yadg.extractors.eclab.mpt.extract"><code class="docutils literal notranslate"><span class="pre">extract()</span></code></a></li>
Expand Down
12 changes: 8 additions & 4 deletions master/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -572,13 +572,19 @@ <h2 id="P">P</h2>
<li><a href="apidoc/yadg.extractors.eclab.html#yadg.extractors.eclab.mpr.process_modules">process_modules() (in module yadg.extractors.eclab.mpr)</a>
</li>
<li><a href="apidoc/yadg.extractors.touchstone.html#yadg.extractors.touchstone.snp.process_options">process_options() (in module yadg.extractors.touchstone.snp)</a>
</li>
<li><a href="apidoc/yadg.extractors.eclab.html#yadg.extractors.eclab.mpt.process_params">process_params() (in module yadg.extractors.eclab.mpt)</a>
</li>
<li><a href="apidoc/yadg.extractors.basic.html#yadg.extractors.basic.csv.process_row">process_row() (in module yadg.extractors.basic.csv)</a>
</li>
<li><a href="apidoc/yadg.html#yadg.core.process_schema">process_schema() (in module yadg.core)</a>
</li>
<li><a href="apidoc/yadg.extractors.eclab.html#yadg.extractors.eclab.mpr.process_settings">process_settings() (in module yadg.extractors.eclab.mpr)</a>

<ul>
<li><a href="apidoc/yadg.extractors.eclab.html#yadg.extractors.eclab.mpt.process_settings">(in module yadg.extractors.eclab.mpt)</a>
</li>
</ul></li>
</ul></td>
</tr></table>

Expand Down Expand Up @@ -653,18 +659,16 @@ <h2 id="S">S</h2>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="apidoc/yadg.extractors.eclab.common.html#yadg.extractors.eclab.common.techniques.technique_params">technique_params() (in module yadg.extractors.eclab.common.techniques)</a>
</li>
<li><a href="apidoc/yadg.extractors.drycal.html#yadg.extractors.drycal.common.TimeDate.time">time (yadg.extractors.drycal.common.TimeDate attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="apidoc/yadg.extractors.basic.html#dgbowl_schemas.yadg.dataschema_5_1.filetype.Basic_csv.Parameters.timestamp">timestamp (dgbowl_schemas.yadg.dataschema_5_1.filetype.Basic_csv.Parameters attribute)</a>

<ul>
<li><a href="apidoc/yadg.extractors.fhimcpt.html#dgbowl_schemas.yadg.dataschema_5_1.filetype.FHI_csv.Parameters.timestamp">(dgbowl_schemas.yadg.dataschema_5_1.filetype.FHI_csv.Parameters attribute)</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="apidoc/yadg.dgutils.html#yadg.dgutils.dateutils.timestamps_from_file">timestamps_from_file() (in module yadg.dgutils.dateutils)</a>
</li>
</ul></td>
Expand Down
Binary file modified master/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion master/searchindex.js

Large diffs are not rendered by default.

Loading

0 comments on commit d6becba

Please sign in to comment.