Release Notes
=============

unreleased
----------

- **Bug fixes**

    - fix :issue:`61` regarding sign of XAS in some cases :mr:`207`

- **Improvements**

    - remove calls to matplotlib tight_layout :mr:`206`

- **New Features**

    -  Read signal description from Fast ADC and ADQ412 digitizers :mr:`209`

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 :code:`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 :code:`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 :code:`get_array()`, add wrappers to some of `extra_data` basic
      functions :mr:`116`
    - new FastADC mnemonics :mr:`112`
    - refactor packaging :mr:`106`
    - add :code:`load_bpt()` function :commit:`9e2c1107`
    - add XTD10 MCP mnemonics :commit:`8b550c9b`
    - add :code:`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`