v4.0.1

This release combines many updates and fixes, mostly related to documentation and the docker container.

What's Changed

• Docker image & CI: Major Docker image rework by @2xB in #71
• Kommon: Bake KConst epoch into header file by @2xB in #75
• Docker: Update to Fedora 38 by @2xB in #77
• Docker: Fix terminals in MyBinder by @2xB in #78
• Documentation: moved gh-pages into main, added "Edit on GitHub" link by @Gon-na in #80
• Welcome page of documentation: added README.md contents by @Gon-na in #81
• fix: remove all references to TBB by @wdconinc in #82
• Documentation: Dependencies and version numbers updated by @Gon-na in #83
• Docker: Add documentation for using Apptainer/Singularity by @2xB in #89
• CI: Add tests for documented dependency installation by @2xB in #90
• Documentation: Adress Duplication, Chapter for KEMField Manual by @Gon-na in #97
• Documentation: Kassiopeia paper PDF, Docker README.md, BuildingImages.md & Chapter structure by @Gon-na in #98
• Documentation: Separate some contents from "Configuring your own simulation" into their own chapters by @Gon-na in #101
• Documentation: Delete visualization.rst & move contents to corresponding chapters by @Gon-na in #102
• KSComponentMath: Fix segfault during destruction by @2xB in #103
• Build: Fix Kassiopeia as submodule by @2xB in #104

New Contributors

• @2xB made their first contribution in #71

Full Changelog: v4.0.0...v4.0.1

v4.0.0

Changelog:

Main Kassiopeia development is moved to github! KATRIN internal development for Kassiopeia is a thing of the past as we aim to create a more lively environment for developers and users of Kassiopeia. This is the last time you will see "Update from Kasper develop" as a commit message!

KEMField:

• Replace KSmartPointer with std::shared_ptr
• Show ZH-statistics at the end of computation
• Added new ZH-solver magfield_coil_field_solver

Kassiopeia

• Added DumpMagnetGeometry tool
• Added zonal harmonic terminator ksterm_zh_radius

Kommon

• Remove TBB dependency

Other

• Minor Bug fixes
• Added BunnySimulation as an example for animations with ParaView

Full Changelog: v3.8.2...v4.0.0

v3.8.2

Changelog:

• C++ 17 is now used by default
• Code cleanup & more consistent CMake configuration

Kassiopeia:

• Updated XML example configurations
• New TrackViewer executable for track/geometry visualization from command line
• Some fixes for ROOT < 6.24

KEMField:

• Improved VTK visualization (via KEMVTKViewer class)
  • Now shows mesh quality by default
  • Total surface charge is now also exported in .vtp files
• Fixed work distribution over nodes with OpenCL+MPI
• Various compilation fixes for Linux & MacOS

KGeoBag:

• The GeometryDump executable can now produce GraphViz output for tree visualization

Kommon:

• Restructured the Kommon into independent library targets, with better handling of internal dependencies

v3.8.0

Changelog:

• Complete overhaul of the build system: now uses proper CMake target definitions
• Various fixes to ROOT and VTK visualization
• Code cleanup & improved formatting

Kassiopeia:

• Added simulation examples; now also contains a Python notebook
• Added text file generator (use particle definitions from ASCII file)
• Fixed simulation issues when using "ghost" particle or linear trajectory
• Fixed issue with missing step in output after particle termination
• Restored old ("classic") cosine distribution in generator; added user options: classic vs. molecular
• Improved support for output field types in all writers (ROOT/VTK/ASCII) and ROOT reader

KEMField:

• Update to OpenCL 2.2 headers
• Added sanity checks for electrostatic solvers
• Fixed issue with reading corrupted files (which led to memory leak)
• Fixed bug in Zonal Harmonic Legendre coefficients (in some rarely used code)
• Fixed bug in electrostatic field map calculation when mirroring is used

KGeoBag:

• Added STL reader with mesh/navigation support; see Kassiopeia example
• Added slice mode for internal VTK viewer (for details open help menu by pressing h)
• Added random generator for annulus surface
• Fixed bugs in extruded spaces (leading to missing / wrongly discretized elements)
• New tool GeometryPrinter to show tree representation of loaded geometry

Kommon:

• Added batch-mode command line flag (-b | -batch); this prevents any visualization windows from opening
• Added TinyExpr formula parser (speeds up parsing of many XML files significantly)
• Fixed log-level command line flags (-v | -q)
• Various improvements/fixes to messaging system; improved warning/error messages

v3.7.7

Update to Kassiopeia 3.7.7

• Code cleanup (clang-format + clang-tidy)
• Faster XML parsing (now using TinyExpr for math expressions)
• New doc target to build global code documentation (Doxygen)
• Added KEMField unit tests
• Added KEMField OpenCL 2.2 headers
• CMake will now clean bin+lib install directories before updating files
• Bugfixes and usability improvements

Note: The code cleanup changes formatting in large parts of the code. Use the provided scripts if you want to merge code that you had forked previously, otherwise it will likely result in conflicts.

v3.7.6

Bugfix release to v3.7.5

• Build fixes
• Update FindFFTW.cmake
• Minor updates to KEMField/KGeoBag

v3.7.5

Bugfix release to v3.7.4

• Fix install paths (related to issue #32)

v3.7.4

Bugfix release to v3.7.3

• Fix handling of commandline arguments in Kassiopeia and KGeoBag
• Add long long variable type and fix KSGeneratorSimulation

Lift Every Voice and Sing!

v3.7.3

Bugfix release to v3.7.2

Some updates to KGeoBag, KEMField, Kassiopeia. Notable:

• KEMField: fix behavior of number_of_bifurcations < 0
• KEMField: allow coaxiality_tolerance = 0 (disable coax. grouping)
• Kassiopeia: fix behavior of --config=file.xml on command line
• Kassiopeia: legacy field bindings (in <kassiopeia> tag) are now deprecated

v3.7.2

Bugfix release to v3.7.1