Skip to content

Commit

Permalink
Release v0.3.2 (#925)
Browse files Browse the repository at this point in the history
* Improve documentation
* Add release notes
* Update crusher script
* Silence warnings on wildstyle
  • Loading branch information
sethrj committed Sep 7, 2023
1 parent eeb9153 commit c35e130
Show file tree
Hide file tree
Showing 9 changed files with 65 additions and 3 deletions.
3 changes: 2 additions & 1 deletion doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ set(DOXYGEN_XML_PROGRAMLISTING NO)

# Annotations break breathe parsing
foreach(_var
CELER_FUNCTION CELER_FORCEINLINE_FUNCTION CELER_CONSTEXPR_FUNCTION
CELER_FUNCTION CELER_FORCEINLINE CELER_FORCEINLINE_FUNCTION CELER_CONSTEXPR_FUNCTION
[[maybe_unused]] CFIF_)
list(APPEND DOXYGEN_PREDEFINED "${_var}=")
endforeach()
Expand All @@ -192,6 +192,7 @@ file(GLOB _DOXYGEN_SOURCE
"${PROJECT_SOURCE_DIR}/src/celeritas/em/*.hh"
"${PROJECT_SOURCE_DIR}/src/celeritas/em/*.cc"
"${PROJECT_SOURCE_DIR}/src/celeritas/em/interactor/*.hh"
"${PROJECT_SOURCE_DIR}/src/celeritas/em/interactor/detail/*.hh"
"${PROJECT_SOURCE_DIR}/src/celeritas/em/model/*.hh"
"${PROJECT_SOURCE_DIR}/src/celeritas/em/model/*.cc"
"${PROJECT_SOURCE_DIR}/src/celeritas/em/distribution/*.hh"
Expand Down
5 changes: 5 additions & 0 deletions doc/api/celeritas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,11 @@ as properties of any secondary particles produced.
.. doxygenclass:: celeritas::detail::UrbanMscScatter
:members: none

.. doxygenclass:: celeritas::SBEnergyDistribution
:members: none
.. doxygenclass:: celeritas::detail::SBPositronXsCorrector
:members: none

.. _api_importdata:

Physics data
Expand Down
34 changes: 34 additions & 0 deletions doc/appendices/release-history/v0.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,40 @@
.. SPDX-License-Identifier: CC-BY-4.0
.. _release_v0.3.2:

Version 0.3.2
=============

*Released 2023/09/07*

Version 0.3.2 is a bug fix release of Celeritas that addresses all
identified discrepancies between Geant4 and Celeritas EM physics processes.
It also should provide better performance when running Celeritas
through Geant4 with many threads sharing the same GPU.

Bug fixes
---------

* Fix sampling of secondary gamma energies in EPlusGGInteractor *(@whokion, #888)*
* Fix unit conversion errors when reading from event file *(@amandalund, #916)*
* Fix Seltzer-Berger max xs for positrons *(@amandalund, #922)*
* Fix Geant4 step limiter when ionization is disabled *(@amandalund, #920)*
* Fix resetting of CUDA streams when running through accel *(@sethrj, #927)*

Reviewers: @sethrj *(4)*, @mrguilima *(1)*, @stognini *(1)*, @amandalund *(1)*

Documentation improvements
--------------------------

* Release v0.3.1 *(@sethrj, #876)*
* Fix density correction calculation in Seltzer-Berger test *(@amandalund, #921)*

Reviewers: @amandalund *(1)*, @sethrj *(1)*

**Full Changelog**: https://github.com/celeritas-project/celeritas/compare/v0.3.1...v0.3.2


.. _release_v0.3.1:

Version 0.3.1
Expand Down
14 changes: 14 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import json
import sys
from pathlib import Path
from sphinx import __version__ as sphinx_version

# -- Project information -----------------------------------------------------

Expand Down Expand Up @@ -138,6 +139,19 @@
'show_powered_by': False,
}

mathjax3_config = {
"tex": {
"macros": {
"dif": r"\;\mathrm{d}",
},
},
"loader": {"load": ["ui/lazy", "output/svg"]},
}

if int(sphinx_version.partition('.')[0]) < 4:
# See https://mathjax.github.io/MathJax-demos-web/convert-configuration/convert-configuration.html
mathjax_config = {"TeX": { "Macros": mathjax3_config["tex"]["macros"]}}

# -- Options for LaTeX output ------------------------------------------------


Expand Down
2 changes: 1 addition & 1 deletion scripts/cmake-presets/wildstyle.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"CELERITAS_USE_SWIG": {"type": "BOOL", "value": "OFF"},
"CELERITAS_USE_VecGeom": {"type": "BOOL", "value": "OFF"},
"CMAKE_CXX_COMPILER": "/usr/bin/g++",
"CMAKE_CXX_FLAGS": "-Wall -Wextra -pedantic -Werror -Wno-error=deprecated-declarations -fdiagnostics-color=always",
"CMAKE_CXX_FLAGS": "-Wall -Wextra -pedantic -Werror -Wno-error=deprecated-declarations -Wno-attributes -fdiagnostics-color=always",
"CMAKE_CXX_FLAGS_RELWITHDEBINFO": "-O2 -g -DNDEBUG -fno-inline -fno-omit-frame-pointer",
"CMAKE_CXX_FLAGS_RELEASE": "-O3 -DNDEBUG -march=skylake-avx512 -mtune=skylake-avx512",
"CMAKE_CUDA_FLAGS": "-Werror all-warnings -Wno-deprecated-gpu-targets",
Expand Down
4 changes: 4 additions & 0 deletions scripts/env/crusher.sh
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,11 @@ export SPACK_ROOT=/ccs/proj/csc404/spack-crusher
export PATH=${_celer_base}/spack/view/bin:$PATH
export CMAKE_PREFIX_PATH=${_celer_base}/spack/view:${CMAKE_PREFIX_PATH}
export MODULEPATH=${SPACK_ROOT}/share/spack/lmod/cray-sles15-x86_64/Core:${MODULEPATH}

# Set up Geant4 data
module load geant4-data
test -n "${G4ENSDFSTATEDATA}"
test -e "${G4ENSDFSTATEDATA}"

# Make llvm available
test -n "${ROCM_PATH}"
Expand Down
1 change: 0 additions & 1 deletion src/celeritas/em/interactor/detail/BremFinalStateHelper.hh
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ namespace detail
//---------------------------------------------------------------------------//
/*!
* Sample the angular distribution of photon from e+/e- Bremsstrahlung.
*
*/
class BremFinalStateHelper
{
Expand Down
3 changes: 3 additions & 0 deletions src/celeritas/em/interactor/detail/SBPositronXsCorrector.hh
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@

namespace celeritas
{
namespace detail
{
//---------------------------------------------------------------------------//
/*!
* Scale SB differential cross sections for positrons.
Expand Down Expand Up @@ -155,4 +157,5 @@ SBPositronXsCorrector::calc_invbeta(real_type gamma_energy) const
}

//---------------------------------------------------------------------------//
} // namespace detail
} // namespace celeritas
2 changes: 2 additions & 0 deletions test/celeritas/em/SeltzerBerger.test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@

#include "celeritas_test.hh"

using celeritas::detail::SBPositronXsCorrector;

namespace celeritas
{
namespace test
Expand Down

0 comments on commit c35e130

Please sign in to comment.