-----------------------------------------------------------------------------

                --- CAEN SpA - Computing Systems Division ---

-----------------------------------------------------------------------------

CoMPASS Release Notes

-----------------------------------------------------------------------------
Rel. 2.5.2 - May 2025
Rel. 2.5.1 - April 2025
Rel. 2.5.0 - March 2025
Rel. 2.4.1 - November 2024
Rel. 2.4.0 - September 2024
Rel. 2.3.0-beta - March 2024
Rel. 2.2.1 - November 2023
Rel. 2.2.0 - September 2023
Rel. 2.1.1 - October 2022
Rel. 2.1.0 - June 2022
Rel. 2.0.1 - February 2022
Rel. 2.0.0 - February 2022
Rel. 2.0.0-beta.2 - January 2022
Rel. 2.0.0-beta - December 2021
Rel. 2.0.0-alpha - May 2021
Rel. 1.6.0 - March 2021
Rel. 1.5.3 - February 2021
Rel. 1.5.2 - November 2020
Rel. 1.5.1 - October 2020
Rel. 1.5.0 - July 2020
Rel. 1.4.2 - June 2020
Rel. 1.4.1 - May 2020
Rel. 1.4.0 - March 2020
Rel. 1.3.0 - November 2019
Rel. 1.2.0 - July 2019
Rel. 1.1.0 - December 2018
Rel. 1.0.8 - October 2018
Rel. 1.0.7 - August 2018
Rel. 1.0.6 - July 2018
Rel. 1.0.5 - June 2018
Rel. 1.0.4 - April 2018 
Rel. 1.0.3.1 - February 2018
Rel. 1.0.3 - January 2018
Rel. 1.0.2 - December 2017
Rel. 1.0.1 - October 2017
Rel. 1.0.0 - September 2017
-----------------------------------------------------------------------------


Description
-----------

This document is updated for every official release of CoMPASS and
it contains various information specific to this software which can not
be found in the User's Manual, available together with the software or on 
the CAEN web site: www.caen.it.


System Requirements
-------------------
 
- Windows 10 build 15063 or higher 64-bit; Linux 64-bit with gcc and g++ >= 11.4.0, glibc >= 2.34, glibcxx >= 3.4.30
- A3818 Driver release 2.0.0 (or higher) in case of using a A3818 card


How to get support
------------------

For technical support, go to https://www.caen.it/mycaen/support/ (login and MyCAEN+ account required).
If you don't have an account or want to update your old one, find the instructions at: https://www.caen.it/support-services/getting-started-with-mycaen-portal/

What's New in Rel. 2.5.3
--------------------------
- Support for 10G UDP firmwares on Digitizer 2.0
- Fix free register access using GUI on VME for addresses >= 0x8000

What's New in Rel. 2.5.2
--------------------------
- Fixed a bug with offline lists and buffers run reprocessing in case of run ID auto increment
- Fixed a bug where offline buffer reprocessing did not stop at the end of the buffer file

What's New in Rel. 2.5.1
--------------------------
- Fixed unexpected crash on Linux
- Fixed user manual link in Linux Snap package
- Fixed quick start manual link in Linux Snap package
- Added button to open log folder on Windows and Linux, now working also in Snap package

What's New in Rel. 2.5.0
--------------------------
- Added support for import and saving 2D spectra in various formats
- Added saving functionality for MCS data
- Extended multilanguage support
- Reduced size of Linux packages
- Extended TXT3 spectrum file format support to TOF plot
- Significantly improved Digitizer 2.0 over USB performance
- Window for integral and instantaneous statistics enhanced and moved to plot window
- Corrected trailing zeros being lost when printing measurements and errors
- Fixed pre-trigger range functionality on Digitizer 1.0 of families x725/x730/x725S/x730S
- Improved sorting performance issues that could lead to errors occurring when time sorting was enabled
- Fixed error that occurred when starting acquisition too early after board connection
- Corrected extension validation for output spectrum when file already exists
- Fixed double popup appearing when saving plots
- Fixed connection to VME digitizers through V4718 USB
- Fixed bug in board data buffers mode for x740 family
- Fixed issue with opening projects with different firmware than currently installed on boards

What's New in Rel. 2.4.1
--------------------------
- IEC spectra generated during a run could have non consistent date
- ROI iso fit: invalid values of sigma, FWHM and FWTM errors

What's New in Rel. 2.4.0
--------------------------
- Syncronization wizard support for digitizer of mixed families (V17xx with VX27xx, and DT57xx/N67xx with DT27xx)
- Improved readout rate and configuration time duration
- Add support for A5818
- Improved messages when using demo firmware
- Support for comments on free-write files (use #, also inline)
- Revamped run info file
- Improved gamma/neutron count display
- Add temperature sensors on Miscellaneous tab (27xx, x725, x723, x751 only)
- Improved spectrum and list import
- Add UserTrgout on TRGOUT_MODE (27xx)
- Fix x751 register dump
- Fix missing 0x800C on register dump
- Fix output file name when when using one file per channel option
- Include the CoMPASS User Manual and QuickStart Guide within the installation package
- Partial support for PID > 32767
- Referencing to CAEN Toolbox rather than CAEN Upgrader
- CoMPASS is not compatible with local installations of Windows SDK 10.0.22000.0 on Visual Studio 2022: add a check in the installer
- Fix set of bit 31 of hex values in parameter tabs
- Installation path on Windows can be modified: default changed to C:\Program Files\CAEN\CoMPASS
- New script in demo folder, to perform a deltaT analysis in which the reference start channel can be any of the used one and all the others are the stop channel
- New script in demo folder, that starting from the list files saved in Waves mode reads the Waveform and does the charge integration
------------
Known issues
------------
CoMPASS 2.0 introduces several new functionalities and updates besides a greatly revised internal structure. 
Even though the new release has been tested and validated there are some issue that are still open and that will be part of the future fixing and enhancing activity.
In more details:
- It is not possible to open projects built with CoMPASS releases 1.x with releases 2.x yet
- Some instabilities might be present in the import of external list and spectrum files
- Some instabilities might be present when running digitizers of the family 27xx at high input rate or, in Waves mode, with very long record length

What's New in Rel. 2.3.0-beta
-----------------------------
- Added support to 2730 family
- FW onboard coincidences for 27XX digitizers
- Added .SPE spectrum file format
- Implemented instantaneous and integral statistics in plot panel
- Revamped MCS plot
- Revamped run info file
- Implemented particle ID feature for particle counting (DPP-PSD firmware only)
- Improved board disconnection handling during acquisition
- Fixed log scale on MCS plot
- Fixed a bug in offline list PSD computation
- Fixed a crash occurring when changing the binning of DeltaT plot
- Fixed board add with V4718 bridge via USB

What's New in Rel. 2.2.1
--------------------------
- Fixed a bug preventing the use of more than one board
- Fixed event time sorting on linux
- Fixed problems with acquisition status after disabling and re-enabling a board
- Fixed ROI slow computation for some linux distributions
- Fixed discrete pattern of PSD plot
- Fixed possible rollover of plot statistics counters

What's New in Rel. 2.2.0
--------------------------
- Parameters free get and set for 27XX
- Support for 27XX hostname
- Fixed 27XX auto trigger
- Fixed acquisition for synchronized 27XX
- Minor bugfixes

What's New in Rel. 2.1.1
--------------------------
- Fix in N42 spectra import
- Bugfixes in energy calibration
- Bugfixes in case one or more boards are disabled

What's New in Rel. 2.1.0
--------------------------
- Support to DPP-PSD for 27XX boards
- Support to veto width parameter
- Auto set of post saturation protection for PHA
- Data through socket available to any IP address
- Fix for software extended timestamp in 725/730 PHA firmware
- Fix in N42 spectra format support
- Fixed ROI linear background
- Fixed DC offset calibration
- Fix in V1782 waveform representation

What's New in Rel. 2.0.1
--------------------------
- Bugfix for external control in linux

What's New in Rel. 2.0.0
--------------------------
- Added feature for external control of data acquisition (sample C++ client in demo folder)
- Possibility to save and load several configuration files within the same project
- Bugfix on CAEN_Dig2 library 

What's New in Rel. 2.0.0-beta.2
--------------------------
- Added support for V4718
- Fixed a bug for V3718 in linux with USB connection

What's New in Rel. 2.0.0-beta
--------------------------
- Several bugfixes to offline data reprocessing
- List import feature
- Added support to 2745 family
- Revamped board synchronization wizard (added 27XX synchronization)
- Revamped DC offset calibration wizard
- Added new parameters to 27XX families
- Implemented fine timestamp for 27XX PHA
- Better handling of parameters correlation
- ROI information saved into N42 spectrum file
- Implemented new flags for X725S/X730S PHA
- Handling of board disconnection

What's New in Rel. 2.0.0-alpha
--------------------------
- Added support to 2740 family
- Offline data reprocessing: board buffers, list, spectra
- Spectra import feature (single or sum)
- Spectra subtraction feature
- Revamped software popups

What's New in Rel. 1.6.0
--------------------------
- Added support for V3718 and A4818
- Fixed a bug in DC offset calibration
- Fixed a bug for daisy chain with A2818

What's New in Rel. 1.5.3
--------------------------
- Fixed a bug for boards with HV Fw release < 2.00
- Fixed a bug for HV polarity values
- Fixed a bug in the feature 'list limited file size' for ROOT tree list
- Fixed a bug for some file name
- Added 'single file not time-sorted' option to list saving
- List minimum file size lowered to 0.01 MB

What's New in Rel. 1.5.2
--------------------------
- Fixed a bug in waveform plot
- Fixed a bug causing a wrong spectrum file format

What's New in Rel. 1.5.1
--------------------------
- Fixed a bug in the 'onboard coincidence' configuration
- Fixed a bug causing wrong HV polarity values

What's New in Rel. 1.5.0
--------------------------
- Bugfixes
- Fixed DC offset calibration wizard
- Fixed offline run
- Added support for X740D boards with DPP-QDC firmware
- Revamped error handling in GUI
- Language selection: added korean and japanese

What's New in Rel. 1.4.2
--------------------------
- Fixed a bug preventing histograms to be filled with converted data (energy calibration, time scaling)

What's New in Rel. 1.4.1
--------------------------
- Fixed a bug causing huge log files when saving list data in ROOT format

What's New in Rel. 1.4.0
--------------------------
- Bugfixes
- Added support for X780 boards with HV control panel
- Added plot E vs E
- Added plot TOF vs E
- Oscilloscope mode for waveform plot
- Saving option for list mode: single time-sorted file or one file per channel
- New 'RAW' level containing all flagged events for offline dead-time reconstruction
- Language selection: english, italian and chinese available
- Improved board connection and startup

What's New in Rel. 1.3.0
--------------------------
- Fixed offline acquisition
- Fixed RC-CR2 smoothing factor for X725/X730 PHA
- Fixed V1782 coarse gain setting
- Fixed onboard coincidence modes for X725/X730 PHA
- Fixed 'Ch0 AND any' onboard coincidence mode
- Other minor bugfixes
- Added support for DT5790 board with HV control panel
- Added support for new X725S and X730S boards
- Implemented binary data output through socket (sample C client in demo folder)
- Waveform plot traces can be hidden

What's New in Rel. 1.2.0
--------------------------
- Bugfixes
- Added support for new V1782 board
- ROIs for spectra analysis
- Revamped energy calibration interface
- MCS plot
- Correct handling of slower data analysis and software memory saturation
- Option to specify list file size

What's New in Rel. 1.1.0
--------------------------
- Bugfixes
- Dead-time calculation completed for all supported boards
- Added support for new x724/x781 PHA firmware (from revision 128.64)
- ADC temperature check and warning
- Added clock source option for DT/NIM digitizers
- Implemented new onboard coincidence mode 'External gate'
- Added PC-Toolkit (.tka) and IEC1455 (.iec) spectrum file formats
- Number of channels of energy spectrum is now a channel parameter

What's New in Rel. 1.0.8
--------------------------
- Added 'global board OR' option to the list of TRGOUT front panel output modes
- Bugfixes in board synchronization wizard
- New onboard coincidence mode: veto from external trigger (TRG IN input)
- New software coincidence mode: veto from board (OR of all channels)
- Virtual channel new tab in configuration GUI: created 'add back' mode

What's New in Rel. 1.0.7
--------------------------
- Bugfixes
- Revamped graphics for cut selection and energy calibration
- Dead-time calculation for x725/x730 boards
- ICR column added to statistics
- Channel integrated statistics panel added to the left side of energy spectrum
- Real-time, dead-time and live-time shown in channel statistics panel
- New spectrum output file formats: N42 and 3 columns

What's New in Rel. 1.0.6
--------------------------
- Fixed a bug in trapezoid settings for x725/x730 PHA

What's New in Rel. 1.0.5
--------------------------
- Fixed a bug which could cause crashes of linux application when enabling software coincidences

What's New in Rel. 1.0.4
--------------------------
- Bugfixes
- Fixed crashes on systems with multiple boards
- Fixed DC offset calibration for x751 boards
- Fixed acquisition real time for TRG_IN and S_IN start modes
- Free-write files now accept empty lines
- Plots, list and spectra saved only for enabled channels
- List can be saved with calibrated energy
- Added option to save only enabled spectra types
- Energy calibration can be imported/exported for boards and single channels

What's New in Rel. 1.0.3.1
--------------------------
- Bugfixes
- Introduced firmware coincidences
- Added 'One channel veto' coincidence mode in software coincidences

What's New in Rel. 1.0.3
--------------------------
- Several bugfixes
- Fixed connection issues with optical link boards
- Fixed compatibility with concurrent installed ROOT on linux
- Improved software coincidences algorithm for low rates
- Possibility to apply a software delay to each channel

What's New in Rel. 1.0.2
--------------------------
- Several bugfixes
- Improved statistics panel
- Introduced demo-mode offline playback
- Added support to the new native A3818 driver rel. 2.0.0 (or higher)
- NOT compatible with previous A3818 driver relases 1.x

What's New in Rel. 1.0.1
--------------------------
- Linux version

What's New in Rel. 1.0.0
--------------------------
- First Release
