Skip to content

Commit

Permalink
Deploying to gh-pages from @ f900928 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@mdoucet
mdoucet committed Jan 8, 2025
1 parent 1bcc058 commit 2569e2c
Show file tree
Hide file tree
Showing 22 changed files with 1,218 additions and 24 deletions.
4 changes: 4 additions & 0 deletions docs/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="/user/conda_environments/">Conda Environments</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/user/event_processing/">Event processing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="/user/workflow/">Specular reflectivity reduction workflow</a>
</li>
</ul>
</div>
</div>
Expand Down
4 changes: 4 additions & 0 deletions docs/api/background/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../user/conda_environments/">Conda Environments</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user/event_processing/">Event processing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user/workflow/">Specular reflectivity reduction workflow</a>
</li>
</ul>
</div>
</div>
Expand Down
6 changes: 4 additions & 2 deletions docs/api/event_reduction/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../user/conda_environments/">Conda Environments</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user/event_processing/">Event processing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user/workflow/">Specular reflectivity reduction workflow</a>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -174,8 +178,6 @@ <h2 id="lr_reduction.event_reduction.EventReflectivity" class="doc doc-heading">


<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#object">object</a></code></p>


<p>Data reduction for the Liquids Reflectometer.
Expand Down
4 changes: 4 additions & 0 deletions docs/api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../user/conda_environments/">Conda Environments</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user/event_processing/">Event processing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../user/workflow/">Specular reflectivity reduction workflow</a>
</li>
</ul>
</div>
</div>
Expand Down
152 changes: 150 additions & 2 deletions docs/api/output/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../user/conda_environments/">Conda Environments</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user/event_processing/">Event processing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../user/workflow/">Specular reflectivity reduction workflow</a>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -189,6 +193,64 @@ <h3 id="lr_reduction.output.RunCollection.add" class="doc doc-heading">

<p>Add a partial R(q) to the collection</p>


<table class="field-list">
<colgroup>
<col class="field-name" />
<col class="field-body" />
</colgroup>
<tbody valign="top">
<tr class="field">
<th class="field-name">Parameters:</th>
<td class="field-body">
<ul class="first simple">
<li>
<b><code>q</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/array.html#module-array">array</a></code>)
–
<div class="doc-md-description">
<p>Q values</p>
</div>
</li>
<li>
<b><code>r</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/array.html#module-array">array</a></code>)
–
<div class="doc-md-description">
<p>R values</p>
</div>
</li>
<li>
<b><code>dr</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/array.html#module-array">array</a></code>)
–
<div class="doc-md-description">
<p>Error in R values</p>
</div>
</li>
<li>
<b><code>meta_data</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#dict">dict</a></code>)
–
<div class="doc-md-description">
<p>Meta data for the run</p>
</div>
</li>
<li>
<b><code>dq</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/array.html#module-array">array</a></code>, default:
<code>None</code>
)
–
<div class="doc-md-description">
<p>Q resolution</p>
</div>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>

</div>
Expand All @@ -206,6 +268,30 @@ <h3 id="lr_reduction.output.RunCollection.add_from_file" class="doc doc-heading"

<p>Read a partial result file and add it to the collection</p>


<table class="field-list">
<colgroup>
<col class="field-name" />
<col class="field-body" />
</colgroup>
<tbody valign="top">
<tr class="field">
<th class="field-name">Parameters:</th>
<td class="field-body">
<ul class="first simple">
<li>
<b><code>file_path</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a></code>)
–
<div class="doc-md-description">
<p>The path to the file to be read</p>
</div>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>

</div>
Expand Down Expand Up @@ -238,8 +324,46 @@ <h3 id="lr_reduction.output.RunCollection.save_ascii" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Save R(Q) in ascii format</p>

<p>Save R(Q) in ASCII format.
This function merges the data before saving. It writes metadata and R(Q) data
to the specified file in ASCII format. The metadata includes experiment details,
reduction version, run title, start time, reduction time, and other optional
parameters. The R(Q) data includes Q, R, dR, and dQ values.</p>


<table class="field-list">
<colgroup>
<col class="field-name" />
<col class="field-body" />
</colgroup>
<tbody valign="top">
<tr class="field">
<th class="field-name">Parameters:</th>
<td class="field-body">
<ul class="first simple">
<li>
<b><code>file_path</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a></code>)
–
<div class="doc-md-description">
<p>The path to the file where the ASCII data will be saved.</p>
</div>
</li>
<li>
<b><code>meta_as_json</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/functions.html#bool">bool</a></code>, default:
<code>False</code>
)
–
<div class="doc-md-description">
<p>If True, metadata will be written in JSON format. Default is False.</p>
</div>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>

</div>
Expand All @@ -266,6 +390,30 @@ <h2 id="lr_reduction.output.read_file" class="doc doc-heading">

<p>Read a data file and extract meta data</p>


<table class="field-list">
<colgroup>
<col class="field-name" />
<col class="field-body" />
</colgroup>
<tbody valign="top">
<tr class="field">
<th class="field-name">Parameters:</th>
<td class="field-body">
<ul class="first simple">
<li>
<b><code>file_path</code></b>
(<code><a class="autorefs autorefs-external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a></code>)
–
<div class="doc-md-description">
<p>The path to the file to be read</p>
</div>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>

</div>
Expand Down
Loading

0 comments on commit 2569e2c

Please sign in to comment.