Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
dmgav committed Jun 20, 2024
1 parent 27f40c8 commit 5bc3dfb
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 47 deletions.
15 changes: 15 additions & 0 deletions PyXRF/_sources/release-notes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@
Release Notes
=============


v1.0.28 (2024-06-20)
====================

Fixed
-----

- Compatibility with Matplotlib 3.9.0: deprecated ``BrokenBarHCollection`` was replaced with ``PolyCollection``.

Added
-----

- Optimized data loaded from Tiled server for SRX beamline.


v1.0.27 (2024-04-18)
====================

Expand Down
1 change: 1 addition & 0 deletions PyXRF/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ <h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Perm
</li>
<li class="toctree-l1"><a class="reference internal" href="credits.html">Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#v1-0-28-2024-06-20">v1.0.28 (2024-06-20)</a></li>
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#v1-0-27-2024-04-18">v1.0.27 (2024-04-18)</a></li>
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#v1-0-26-2024-04-07">v1.0.26 (2024-04-07)</a></li>
<li class="toctree-l2"><a class="reference internal" href="release-notes.html#v1-0-25-2024-01-18">v1.0.25 (2024-01-18)</a></li>
Expand Down
108 changes: 62 additions & 46 deletions PyXRF/release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,33 +32,48 @@

<section id="release-notes">
<h1>Release Notes<a class="headerlink" href="#release-notes" title="Permalink to this heading"></a></h1>
<section id="v1-0-27-2024-04-18">
<h2>v1.0.27 (2024-04-18)<a class="headerlink" href="#v1-0-27-2024-04-18" title="Permalink to this heading"></a></h2>
<section id="v1-0-28-2024-06-20">
<h2>v1.0.28 (2024-06-20)<a class="headerlink" href="#v1-0-28-2024-06-20" title="Permalink to this heading"></a></h2>
<section id="fixed">
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Fixed ‘Save spectra for pixels in selected region’ (‘Maps’ tab).</p></li>
<li><p>Selection of axes scale (Pixels vs. Positions) is not reset after each fitting of the map.</p></li>
<li><p>Compatibility with Matplotlib 3.9.0: deprecated <code class="docutils literal notranslate"><span class="pre">BrokenBarHCollection</span></code> was replaced with <code class="docutils literal notranslate"><span class="pre">PolyCollection</span></code>.</p></li>
</ul>
</section>
<section id="added">
<h3>Added<a class="headerlink" href="#added" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Optimized data loaded from Tiled server for SRX beamline.</p></li>
</ul>
</section>
</section>
<section id="v1-0-27-2024-04-18">
<h2>v1.0.27 (2024-04-18)<a class="headerlink" href="#v1-0-27-2024-04-18" title="Permalink to this heading"></a></h2>
<section id="id1">
<h3>Fixed<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Fixed ‘Save spectra for pixels in selected region’ (‘Maps’ tab).</p></li>
<li><p>Selection of axes scale (Pixels vs. Positions) is not reset after each fitting of the map.</p></li>
</ul>
</section>
<section id="id2">
<h3>Added<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>APS AXO quantitative calibration standard.</p></li>
</ul>
</section>
</section>
<section id="v1-0-26-2024-04-07">
<h2>v1.0.26 (2024-04-07)<a class="headerlink" href="#v1-0-26-2024-04-07" title="Permalink to this heading"></a></h2>
<section id="id1">
<h3>Fixed<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<section id="id3">
<h3>Fixed<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Compatibility with recent Numba: removed unsupported <code class="docutils literal notranslate"><span class="pre">np.asarray</span></code> function
in the code compiled by Numba.</p></li>
</ul>
</section>
<section id="id2">
<h3>Added<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<section id="id4">
<h3>Added<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>New <code class="docutils literal notranslate"><span class="pre">make_hdf</span></code> parameter: <code class="docutils literal notranslate"><span class="pre">catalog</span></code>.</p></li>
<li><p>New <code class="docutils literal notranslate"><span class="pre">pyxrf</span></code> CLI parameter: <code class="docutils literal notranslate"><span class="pre">--catalog-name</span></code> or <code class="docutils literal notranslate"><span class="pre">-c</span></code>.</p></li>
Expand All @@ -68,17 +83,17 @@ <h3>Added<a class="headerlink" href="#id2" title="Permalink to this heading">¶<
</section>
<section id="v1-0-25-2024-01-18">
<h2>v1.0.25 (2024-01-18)<a class="headerlink" href="#v1-0-25-2024-01-18" title="Permalink to this heading"></a></h2>
<section id="id3">
<h3>Fixed<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<section id="id5">
<h3>Fixed<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Formatting of TXT file saved by ‘Save Spectrum/Fit’: the first column now
contains the energy values in kEv (previously, the first column contained
the index of the energy values).</p></li>
<li><p>Fixed issue with Dask v2023.9.3 and recent Numpy/Numba.</p></li>
</ul>
</section>
<section id="id4">
<h3>Added<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<section id="id6">
<h3>Added<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Quantitative calibration standards AXO C1 and C10 were added.</p></li>
</ul>
Expand All @@ -92,32 +107,32 @@ <h3>Changed<a class="headerlink" href="#changed" title="Permalink to this headin
</section>
<section id="v1-0-24-2023-05-12">
<h2>v1.0.24 (2023-05-12)<a class="headerlink" href="#v1-0-24-2023-05-12" title="Permalink to this heading"></a></h2>
<section id="id5">
<h3>Fixed<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
<section id="id7">
<h3>Fixed<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Compatibility with Dask/Distributed v2023.04.x.</p></li>
</ul>
</section>
<section id="id6">
<h3>Added<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h3>
<section id="id8">
<h3>Added<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Support for loading data generated by updated Bluesky plans (Community Xspress3 IOC).</p></li>
</ul>
</section>
</section>
<section id="v1-0-23-2022-03-19">
<h2>v1.0.23 (2022-03-19)<a class="headerlink" href="#v1-0-23-2022-03-19" title="Permalink to this heading"></a></h2>
<section id="id7">
<h3>Fixed<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
<section id="id9">
<h3>Fixed<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>PyXRF is now compatible with PyQT 5.15.</p></li>
</ul>
</section>
</section>
<section id="v1-0-22-2022-02-28">
<h2>v1.0.22 (2022-02-28)<a class="headerlink" href="#v1-0-22-2022-02-28" title="Permalink to this heading"></a></h2>
<section id="id8">
<h3>Added<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<section id="id10">
<h3>Added<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Extended functionality of quantitative analysis feature: additional combo box allows
to select reference emission line from the list of emission lines with existing calibration.
Expand All @@ -127,8 +142,8 @@ <h3>Added<a class="headerlink" href="#id8" title="Permalink to this heading">¶<
calibration (old functionality)</p></li>
</ul>
</section>
<section id="id9">
<h3>Fixed<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<section id="id11">
<h3>Fixed<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Fixed the code for loading step scan data at SRX. PyXRF can now load the step scan
data recorded using 2023-1.0 environment.</p></li>
Expand All @@ -138,8 +153,8 @@ <h3>Fixed<a class="headerlink" href="#id9" title="Permalink to this heading">¶<
</section>
<section id="v1-0-21-2022-12-11">
<h2>v1.0.21 (2022-12-11)<a class="headerlink" href="#v1-0-21-2022-12-11" title="Permalink to this heading"></a></h2>
<section id="id10">
<h3>Added<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<section id="id12">
<h3>Added<a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">make_hdf</span></code> now supports <code class="docutils literal notranslate"><span class="pre">Fly1D</span></code>, <code class="docutils literal notranslate"><span class="pre">dmesh</span></code> and <code class="docutils literal notranslate"><span class="pre">dscan</span></code> (HXN).</p></li>
<li><p>New parameter <code class="docutils literal notranslate"><span class="pre">fail_for_plan_types</span></code> is added <code class="docutils literal notranslate"><span class="pre">make_hdf</span></code>. The parameter accepts
Expand All @@ -151,33 +166,33 @@ <h3>Added<a class="headerlink" href="#id10" title="Permalink to this heading">¶
</section>
<section id="v1-0-20-2022-08-19">
<h2>v1.0.20 (2022-08-19)<a class="headerlink" href="#v1-0-20-2022-08-19" title="Permalink to this heading"></a></h2>
<section id="id11">
<h3>Changed<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
<section id="id13">
<h3>Changed<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Current working directory can now be changed at any time. The respective button is not deactivated after the first HDF5 file is opened.
The working directory is used to create new HDF5 files (<code class="docutils literal notranslate"><span class="pre">Load</span> <span class="pre">Run..</span></code>) and as a default directory for ‘Open’ and ‘Save’ dialog boxes.</p></li>
<li><p>SRX beamline: The positions for course stages are now generated based on plan input parameters. The following motors are supported:
<code class="docutils literal notranslate"><span class="pre">nano_stage_x</span></code>, <code class="docutils literal notranslate"><span class="pre">nano_stage_y</span></code>, <code class="docutils literal notranslate"><span class="pre">nano_stage_z</span></code>, <code class="docutils literal notranslate"><span class="pre">nano_stage_topx</span></code>, <code class="docutils literal notranslate"><span class="pre">nano_stage_topz</span></code>.</p></li>
</ul>
</section>
<section id="id12">
<h3>Fixed<a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<section id="id14">
<h3>Fixed<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Compatibility with Numba v0.56.x.</p></li>
</ul>
</section>
</section>
<section id="v1-0-19-2022-08-19">
<h2>v1.0.19 (2022-08-19)<a class="headerlink" href="#v1-0-19-2022-08-19" title="Permalink to this heading"></a></h2>
<section id="id13">
<h3>Added<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
<section id="id15">
<h3>Added<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>New button <code class="docutils literal notranslate"><span class="pre">Add</span> <span class="pre">All</span> <span class="pre">Elements</span></code> is added to Image Wizard. The button adds all element emission lines to the selection.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Auto</span></code> checkbox is added to the windows ‘Fitting Parameters for Individual Emission Lines’ and ‘Shared Detailed Fitting Parameters’.</p></li>
</ul>
</section>
<section id="id14">
<h3>Changed<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<section id="id16">
<h3>Changed<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>The value of the parameter <code class="docutils literal notranslate"><span class="pre">Userpeak.._delta_center</span></code> is now displayed as absolute energy (true peak position in keV)
instead of relative energy (difference between the absolute energy and the ‘base’ energy 5 keV) in the window
Expand All @@ -187,8 +202,8 @@ <h3>Changed<a class="headerlink" href="#id14" title="Permalink to this heading">
</section>
<section id="v1-0-18-2022-08-08">
<h2>v1.0.18 (2022-08-08)<a class="headerlink" href="#v1-0-18-2022-08-08" title="Permalink to this heading"></a></h2>
<section id="id15">
<h3>Changed<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
<section id="id17">
<h3>Changed<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>The algorithm for loading SRX raw data from databroker now fixes corrupt rows by replacing the data
with data from the preceding or next valid row.</p></li>
Expand All @@ -199,14 +214,14 @@ <h3>Changed<a class="headerlink" href="#id15" title="Permalink to this heading">
</section>
<section id="v1-0-17-2022-06-16">
<h2>v1.0.17 (2022-06-16)<a class="headerlink" href="#v1-0-17-2022-06-16" title="Permalink to this heading"></a></h2>
<section id="id16">
<h3>Added<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
<section id="id18">
<h3>Added<a class="headerlink" href="#id18" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Support for Python 3.10</p></li>
</ul>
</section>
<section id="id17">
<h3>Fixed<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
<section id="id19">
<h3>Fixed<a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Updated the code for loading raw data at SRX beamline to be compatible with Databroker V1
(intake version).</p></li>
Expand All @@ -218,29 +233,29 @@ <h3>Fixed<a class="headerlink" href="#id17" title="Permalink to this heading">¶
</section>
<section id="v1-0-16-2022-05-26">
<h2>v1.0.16 (2022-05-26)<a class="headerlink" href="#v1-0-16-2022-05-26" title="Permalink to this heading"></a></h2>
<section id="id18">
<h3>Added<a class="headerlink" href="#id18" title="Permalink to this heading"></a></h3>
<section id="id20">
<h3>Added<a class="headerlink" href="#id20" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Support for the detector <code class="docutils literal notranslate"><span class="pre">xs4</span></code> (SRX beamline).</p></li>
</ul>
</section>
<section id="id19">
<h3>Changed<a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<section id="id21">
<h3>Changed<a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Databroker v1 is used for loading data at SRX beamline.</p></li>
</ul>
</section>
</section>
<section id="v1-0-15-2022-04-06">
<h2>v1.0.15 (2022-04-06)<a class="headerlink" href="#v1-0-15-2022-04-06" title="Permalink to this heading"></a></h2>
<section id="id20">
<h3>Added<a class="headerlink" href="#id20" title="Permalink to this heading"></a></h3>
<section id="id22">
<h3>Added<a class="headerlink" href="#id22" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>SRX data, new format: support for step scans using top stages.</p></li>
</ul>
</section>
<section id="id21">
<h3>Fixed<a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<section id="id23">
<h3>Fixed<a class="headerlink" href="#id23" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Fixed a bug in <code class="docutils literal notranslate"><span class="pre">fit_pixel_data_and_save()</span></code> that prevented saving maps as ‘TXT’ files.</p></li>
<li><p>SRX data, new format: proper handling of scan data using both <code class="docutils literal notranslate"><span class="pre">xs</span></code> and <code class="docutils literal notranslate"><span class="pre">xs2</span></code> detectors.</p></li>
Expand Down Expand Up @@ -313,6 +328,7 @@ <h3>Navigation</h3>
<li class="toctree-l1"><a class="reference internal" href="questions.html">Frequently asked questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="credits.html">Credits</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-28-2024-06-20">v1.0.28 (2024-06-20)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-27-2024-04-18">v1.0.27 (2024-04-18)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-26-2024-04-07">v1.0.26 (2024-04-07)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#v1-0-25-2024-01-18">v1.0.25 (2024-01-18)</a></li>
Expand Down
Loading

0 comments on commit 5bc3dfb

Please sign in to comment.