Skip to content

Version 2.0.0

Compare
Choose a tag to compare
@leloup314 leloup314 released this 02 Feb 13:36
· 397 commits to main since this release
0fbc351

Version 2

Version 2 is the first release of irrad_control after moving the development from Silab-Bonn to the Cyclotron-Bonn organization. It ships with major changes compared to version 1.3.0 and reflects the upgrade process of the irradiation site between mid 2021- mid 2022.

The original repository, https://github.com/SiLab-Bonn/irrad_control, will be archived and development will exclusively continue at https://github.com/Cyclotron-Bonn/irrad_control from this release.

Major changes

In this version, irrad_control underwent a major restructure to achieve the following:

  • Full implementation of the upgraded irradiation setup, allowing to use all features
  • Easy integration of newly-added hardware
  • Improve capabilities of the irradiation procedure to allow flexible / individual irradiation campaigns
  • Additional data acquisition / analysis during irradiation for transparency
  • Improve general stability of the software
  • Improve installation and testing
  • Minor bug fixes compared to the previous version.

New features

  • Reworked README and added publications, see SiLab-Bonn/irrad_control#73
  • Rework of motorstage-related code, allowing easy integration of any motorstage, see SiLab-Bonn/irrad_control#47
  • Acquisition of data of motorstages: for every movement of every motorstage, data such as movement status, position, speed, timestamp, etc. is recorded and written to the respective output file, see SiLab-Bonn/irrad_control#44
  • A versatile DUT scan routine: enabling to interface any 2D motorstage, perform scan, allow calculation of scan area according to beam parameters, pause scan manually, see SiLab-Bonn/irrad_control#41
  • Major code restructure / refactor to better separate code and manage responsibilities, allow more flexibility when writing generic devices, see #4
  • Rework of the application configuration: config files are not part of version control anymore but stored in OS-foreseen location. Configuration does not get lost when re-installing, see #7
  • Rework of the irradiation DAQ: data acquisiton now depending on ion type and energy. IrradIon class provides calculations of stopping powers, ion rates, as well as downstream energy degradation up to the DUT position by combining GEANT4 simulation with NIST PSTAR / ASTAR data, see #7 #8
  • Improved testing & installation procedure, see #9
  • General stability improvements in host - server communication and shutdown procedure, see #12

Closed issues

The following issues are closed by this release. Some issues are related to aforementioned features

Analysis CLI

The analysis CLI, irrad_analyse, will not work on irradiation files across different versions e.g. irradiation output files produced by version 1.X.X cannot be analyzed using version 2.X.X and vice-versa. Please checkout the respective version tag using git checkout my_version_tag, e.g. git checkout v.1.3.0 for version 1.3.0, and reinstall the package using pip install -e . in the root directory.