preparing release 1.0.0

Author: ichinii

CHANGELOG.md

@@ -1,21 +1,62 @@
-# Changes
+## Changelog
+
+### Breaking Changes
+
+* For h5 files, the internal data layout has changed. rayx/rayx-ui wont be able to write/read the old format
 
 ### RAYX-CORE
-* Improve tests on correctness for gratings by @fannyzotter in https://github.com/hz-b/rayx/pull/307
-* Rework Refrac2D by @fannyzotter in https://github.com/hz-b/rayx/pull/308
-* Exchange Vulkan GPU tracer with Alpaka (using Cuda) and enable multithreaded CPU tracing. by @ichinii in https://github.com/hz-b/rayx/pull/304
-* adapt compile.sh by @ichinii in https://github.com/hz-b/rayx/pull/317
-* Rework/core classes by @Atraxus in https://github.com/hz-b/rayx/pull/316
-* Exchange custom math library with std math library for complex numbers and trigonometry
-* Minor bug fixes
+* New optical element: **Crystal** (https://github.com/hz-b/rayx/pull/380)
+    * For more information visit our [wiki](https://hz-b.github.io): https://hz-b.github.io/rayx/Model/BeamlineObjects/OpticalElements/Crystal.html
+* New optical element: **Single layer foil** (https://github.com/hz-b/rayx/pull/391)
+    * For more information visit our [wiki](https://hz-b.github.io): https://hz-b.github.io/rayx/Model/BeamlineObjects/OpticalElements/Foil.html
+* Beamlines are now represented as a tree graph (improved support for grouping of elements) (https://github.com/hz-b/rayx/pull/350)
+* For h5 files, the internal data layout has changed (https://github.com/hz-b/rayx/pull/374)
+    * Each attribute is stored separately
+    * Each attribute may or may not be stored, depending on format options set (`--format ...` flag)
+* May record events from a single element only (https://github.com/hz-b/rayx/pull/365)
+* May record specific attributes of events only (https://github.com/hz-b/rayx/pull/374)
+* Advance electric field using optical path length (https://github.com/hz-b/rayx/pull/394)
+* Rework verbose mode console output (`--verbose` flag)
+* Fix efficiency calculation
+* Updated dependency `alpaka` to version `2.0.0` (https://github.com/alpaka-group/alpaka/releases/tag/2.0.0) (https://github.com/hz-b/rayx/pull/399)
+    * Inherently, the build dependency `boost` was dropped in rayx
+* By default, rayx-core now compiles for all major cuda architectures (https://github.com/hz-b/rayx/pull/399)
+
+### RAYX (cli)
+
+* Rename cli format options
+`-F,--format TEXT            Write specific Ray attributes to output H5 files. Provide a space-separated list of attributes. default value: "path_id position_x position_y position_z event_type direction_x direction_y direction_z energy electric_field_x electric_field_y electric_field_z path_length order element_id source_id "`
+* Add cli option to dump meta data of h5 and rml files
+`-D,--dump TEXT              Dump the meta data of a file (h5 or rml)`
+* Add cli option to record events from a single element only
+`-R,--record-element INT     Record events only for a specifc element`
+* Add cli option to specify output filepath of csv or h5 files (https://github.com/hz-b/rayx/pull/366)
+`-o,--output TEXT            Output path or filename`
 
 ### RAYX-UI
-* RAYX-UI Cleanup by @Atraxus in https://github.com/hz-b/rayx/pull/292
-* RAYX-UI Optimization by @EnricoAhlers in https://github.com/hz-b/rayx/pull/305
-* Rework file dialog by @Atraxus in https://github.com/hz-b/rayx/pull/290
-* New: UI for beamline design by @EnricoAhlers in https://github.com/hz-b/rayx/pull/296
+
+* Improve Wayland support on Linux (https://github.com/hz-b/rayx/pull/353)
+* Add flag to run in verbose mode (`--verbose` flag) (https://github.com/hz-b/rayx/pull/351)
+
+### Other Changes
+* Improved ease of compilation using `compile.sh` script (https://github.com/hz-b/rayx/pull/385)
+* Add CMake option to enable/disable OpenMP backend (https://github.com/hz-b/rayx/pull/357)
+* Add CMake option to build `rayx-core` as static lib (https://github.com/hz-b/rayx/pull/343)
+* Enable use of rayx as a submodule in another project (https://github.com/hz-b/rayx/pull/359)
+* Add shell.nix file, for starting a nix-shell environment, containing all dependencies required to build (https://github.com/hz-b/rayx/pull/389)
 
 ## New Contributors
-* @ichinii made their first contribution in https://github.com/hz-b/rayx/pull/304
+* @JonasTrenkler made their first contribution (https://github.com/hz-b/rayx/pull/357)
+
+## Other
+
+**Full Changelog**: https://github.com/hz-b/rayx/compare/v0.21.2...v1.0.0
+
+<!-- ### Runtime Performance Comparison -->
+<!-- Runtime performance compared to the previous release (https://github.com/hz-b/rayx/tree/v0.21.2) -->
+
+## Probably coming soon
 
-**Full Changelog**: https://github.com/hz-b/rayx/compare/v0.20.0...v0.21.0
+* Mac support including multithreaded tracing on CPU using OpenMP (x86 and arm)
+* Nix flake for reproducable dependency handling to make developing and building rayx more accessible
+* Multi layer foil

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
 
 # ---- Project ----
-project(RAYX VERSION 0.21.7)
+project(RAYX VERSION 1.0.0)
 if(MSVC)
     set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
 endif()