changelog.rst



To find the state of this project's repository at the time of any of these versions, check out the tags.


Release Notes

unreleased


Bug fixes


fix :issue:`61` regarding sign of XAS in some cases :mr:`207`
Use xarray.values instead of .to_numpy() for backward-compatibility :mr:`214`
fix :issue:`23` regarding API documentation generation :mr:`221`
fix :issue:`64` regarding loading a subset of trains :mr:`226`, :mr:`230`
fix :issue:`67` regarding bunch pattern :mr:`245`
fix :issue:`44` regarding notebook for DSSC geometry quadrants alignment :mr:`247`
fix :issue:`52` use extra-geom detector helper function for azimuthal integration :mr:`248`
fix :issue:`18` regarding using reserved partition with sbatch :mr:`250`
fix :issue:`68` now using findxfel command :mr:`256`
fix :issue:`69` to speed up BOZ Small data and deal with missing intra-darks :mr:`256`
fix :issue:`71` regarding rounding error in BOZ analysis related to timing :mr:`256`


Improvements


remove calls to matplotlib tight_layout :mr:`206`
Improved hRIXS class and utilities :mr:`182`
Documentation on extracting digitizer peaks, clean up of digitizer functions :mr:`215`
Improved peak-finding algorithm for digitizer traces :mr:`216`, :mr:`227`
Only load bunch pattern table when necessary :mr:`234`, :mr:`245`
Document the HRIXS class :mr:`238`
notebook example of DSSC azimuthal integration for time delay scans :mr:`249`
provide drop-intra-darks option in BOZ analysis :mr:`256`
improve automatic ROIs finding for BOZ analysis :mr:`256`
prevent flat field correction from turning negative in BOZ analysis :mr:`259`
update documentation to the new exfel-python environment :mr:`266`


New Features


Read signal description from Fast ADC and ADQ412 digitizers :mr:`209`, :mr:`212`
Mnemonics for XRD devices :mr:`208`
Add function to align OL to FEL pulse Id :mr:`218`
Add reflectivity routine :mr:`218`
Possibility to extract run values of mnemonics :mr:`220`, :mr:`232`
Add get_undulator_config function :mr:`225`
Document the HRIXS class :mr:`238`
Include double counts for hRIXS SPC algorithms :rm:`239`
Add Viking spectrometer analysis class :mr:`240`
Add GPU accelaration for BOZ correction determination :mr:`254`
Issues warning when loading data with > 5% missing trains :mr:`263`


1.6.0


Bug fixes


fix :issue:`45` SLURM scripts embedded in and download link available
from documentation :mr:`171`
fix :issue:`8` regarding azimuthal integration with pyFAI and hexagonal
DSSC pixel splitting by providing an example notebook :mr:`174`
fix :issue:`46` with a change in dask groupby mean behavior :mr:`174`
fix :issue:`47` SLURM script not using the correct kernel :mr:`176`
fix :issue:`51` make sure that BAM units are in ps :mr:`183`
fix :issue:`50` and :issue:`54` relating to package dependencies
fix :issue:`57` adds target mono energy mnemonic
fix :issue:`55` implementingd dask auto rechunking in notebooks
fix :issue:`53` wrong flat field correction sometimes being calculated
fix :issue:`56` future warning on xarray.ufuncs :mr:`189`


Improvements


update version of BAM mnemonics :mr:`175`
update version GATT-related mnemonics, add transmission_col2 :mr:`172`
reorganize the Howto section :mr:`169`
improve SLURM scripts with named arguments :mr:`176`
adds notebook for DSSC fine timing analysis :mr:`184` and :mr:`185`
numerous improvements for the flat field correction calculation
in the BOZ analysis, including fitting domain functions, hexagonal
pixel lattice, possibility to switch off flat field symmetry constraints
and a refine fit function with regularization term :mr:`186`
simplifies flat field calculation by using directly the refined fit
procedure which works with far fewer input parameters :mr:`202`


New Features


add routine for fluence calibration :mr:`180`
add Fast ADC 2 mnemonics :mr:`200`


1.5.0


Bug fixes


fix :issue:`39` providing a changelog in the documentation :mr:`164`
fix :issue:`37` BOZ analysis :mr:`158`
fix :issue:`36` mnemonics :mr:`159`
fix :issue:`35` BOZ notebook dependencies :mr:`157`
fix :issue:`34` BOZ time delay calculations and plotting :mr:`154`
fix :issue:`32` significantly speeding up in XAS binning calculation :mr:`151`
fix :issue:`27` improving BOZ analysis :mr:`146`
fix :issue:`28` pp pattern in DSSC dask binning :mr:`144`
fix :issue:`26` several BOZ analysis improvements :mr:`135`


Improvements


checks if single-version mnemonics is in all_sources :mr:`163`
add get_bam_params() :mr:`160`
only check keys if menmonic has more than one version :commit:`ae724d3c`
add FFT focus lens mnemonics :mr:`156`
add dask as dependency :mr:`155`
renamed FFT sample Z mnemonics :mr:`153`
add virtual sample camera LLC_webcam1 into mnemonics :mr:`152`
fix digitizer check params :mr:`149`
improve installation instruction :mr:`145`
add Newton camera :mr:`142`
simplified mnemonics_for_run() :commit:`3cc98c16`
adds Horizontal FDM to mnemonics :mr:`141`
add setup documentation :mr:`140`
numerous PES fixes :mr:`143`, :mr:`130`, :mr:`129`, :mr:`138`, :mr:`137`
change in FFT sample Z mnemonics :mr:`125` and :mr:`124`
add MTE3 camera :mr:`123`
add KB benders averager :mr:`120` and :mr:`119`


New Features


implement the Beam-splitting Off-axis Zone-plate analysis:
:mr:`150`, :mr:`139`, :mr:`136`, :mr:`134`, :mr:`133`, :mr:`132`,
:mr:`131`, :mr:`128`, :mr:`127`, :mr:`126`, :mr:`115`
introduce dask assisted DSSC binning, fixing :issue:`24` and :issue:`17`


1.4.0


Bug fixes


fix :issue:`22` using extra-data read machinery :mr:`105`
fix :issue:`21` and :issue:`12` introducing mnemonics version :mr:`104`


Improvements


fix get_array(), add wrappers to some of extra_data basic
functions :mr:`116`
new FastADC mnemonics :mr:`112`
refactor packaging :mr:`106`
add load_bpt() function :commit:`9e2c1107`
add XTD10 MCP mnemonics :commit:`8b550c9b`
add digitizer_type() function :commit:`75eb0bca`
separate FastADC and ADQ412 code :commit:`939d32b9`
documentation centralized on rtd.xfel.eu :mr:`103`
simplify digitizer functions and pulseId coordinates assignment for XGM
and digitizers :mr:`100`


New Features


base knife-edge scan analysis implementation :mr:`107`
add PES :mr:`108`
integrate documentation to rtd.xfel.eu :mr:`103` and :mr:`99`


1.1.2rc1


Bug Fixes


Improvements


New Feature


introduce change in package structure, sphinx documentation and
DSSC binning class :mr:`87`