Documentation Updates - Githubissues

LDMX-Software / G4DarkBreM

Dark Bremmstrahlung in Geant4 with MadGraph event libraries.

https://ldmx-software.github.io/G4DarkBreM/

Apache License 2.0

0 stars 1 forks source link

Documentation Updates #6

Closed tomeichlersmith closed 1 year ago

tomeichlersmith commented 1 year ago

[x] ~Details on requirements from Boost - specifically that we only require the header-only Boost.Math.Quadrature library~
[x] Update and clarify scample documentation and name
[x] Clarification comments on lambda expressions
[x] #5
[x] Boost version requirements
[x] Geant4 version requirements
[x] More detail on MakePlaceholders and why it is there
[x] Remove comment in alwaysCreateNewLepton_==False branch

tomeichlersmith commented 1 year ago

Inspecting Boost's version history, it looks like v1.68.0 is the earliest version that has an implementation of the integration we use. The current version is v1.80.0 and v1.74.0 is what is in the Linux Mint 21 repositories.

Geant4 is going to be more difficult. The main "hooks" into Geant4 are (1) how we define the G4APrime and (2) how we define our G4Process. Any drastic changes in those APIs would require a redesign of this library. Right now, I have tested compilation of this library with v10.2.3, v10.7.4, and v11.0.3.

tomeichlersmith commented 1 year ago

I am developing a GitHub action to test compilation on a variety of Boost versions and Geant4 versions. The main obstacle at the moment is attempting to speed this action up since the Geant4 build+install takes ~1.5hrs.