Skip to content

Commit

Permalink
build based on 2247135
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 4, 2024
1 parent 19b5a19 commit be11649
Show file tree
Hide file tree
Showing 44 changed files with 285 additions and 153 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-04T12:36:04","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-04T13:29:06","documenter_version":"1.8.0"}}
2 changes: 1 addition & 1 deletion dev/api/index.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/examples/B1/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@

return physWorld ## return a pointer to the G4PhysicalVolume
end</code></pre><pre><code class="nohighlight hljs">constructB1Detector (generic function with 1 method)</code></pre><p>crate an instance of the detector construction and physics list to be used in the simulation</p><pre><code class="language-julia hljs">detctor = G4JLDetectorConstruction(constructB1Detector)
physics = QBBC()</code></pre><pre><code class="nohighlight hljs">Geant4.QBBCAllocated(Ptr{Nothing} @0x0000000002811c00)</code></pre><h2 id="Define-User-Actions"><a class="docs-heading-anchor" href="#Define-User-Actions">Define User Actions</a><a id="Define-User-Actions-1"></a><a class="docs-heading-anchor-permalink" href="#Define-User-Actions" title="Permalink"></a></h2><pre><code class="language-julia hljs">function buildApp(self::G4JLActionInitialization, ::Nothing)
physics = QBBC()</code></pre><pre><code class="nohighlight hljs">Geant4.QBBCAllocated(Ptr{Nothing} @0x00000000030b3ed0)</code></pre><h2 id="Define-User-Actions"><a class="docs-heading-anchor" href="#Define-User-Actions">Define User Actions</a><a id="Define-User-Actions-1"></a><a class="docs-heading-anchor-permalink" href="#Define-User-Actions" title="Permalink"></a></h2><pre><code class="language-julia hljs">function buildApp(self::G4JLActionInitialization, ::Nothing)
# Create particle gun
particle_gun = G4JLParticleGun()
# Setup particle gun
Expand All @@ -101,7 +101,7 @@
# Register and relinquish ownership
SetUserAction(self, move!(particle_gun))
end
app = G4JLActionInitialization(buildApp)</code></pre><pre><code class="nohighlight hljs">Geant4.G4JLActionInitializationAllocated(Ptr{Nothing} @0x000000000302a770)</code></pre><h2 id="Instantiate-RunManager-and-initialize"><a class="docs-heading-anchor" href="#Instantiate-RunManager-and-initialize">Instantiate RunManager and initialize</a><a id="Instantiate-RunManager-and-initialize-1"></a><a class="docs-heading-anchor-permalink" href="#Instantiate-RunManager-and-initialize" title="Permalink"></a></h2><pre><code class="language-julia hljs"># Construct the default run manager and set initializers
app = G4JLActionInitialization(buildApp)</code></pre><pre><code class="nohighlight hljs">Geant4.G4JLActionInitializationAllocated(Ptr{Nothing} @0x00000000033a7fb0)</code></pre><h2 id="Instantiate-RunManager-and-initialize"><a class="docs-heading-anchor" href="#Instantiate-RunManager-and-initialize">Instantiate RunManager and initialize</a><a id="Instantiate-RunManager-and-initialize-1"></a><a class="docs-heading-anchor-permalink" href="#Instantiate-RunManager-and-initialize" title="Permalink"></a></h2><pre><code class="language-julia hljs"># Construct the default run manager and set initializers
runManager = G4RunManager()

# Register User initialization objects and relinquish ownership
Expand Down Expand Up @@ -136,4 +136,4 @@
# go
ApplyCommand(UImanager, &quot;/run/beamOn 1&quot;)</code></pre><pre><code class="nohighlight hljs">0</code></pre><p>Change the energy and run again</p><pre><code class="language-julia hljs">ApplyCommand(UImanager, &quot;/gun/particle e+&quot;)
ApplyCommand(UImanager, &quot;/gun/energy 60 MeV&quot;)
ApplyCommand(UImanager, &quot;/run/beamOn 1&quot;)</code></pre><pre><code class="nohighlight hljs">0</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../api/">« Public API</a><a class="docs-footer-nextpage" href="../B2a/">Basic/B2a Example »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 12:36">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
ApplyCommand(UImanager, &quot;/run/beamOn 1&quot;)</code></pre><pre><code class="nohighlight hljs">0</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../api/">« Public API</a><a class="docs-footer-nextpage" href="../B2a/">Basic/B2a Example »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 13:29">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/examples/B2a/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
physics_type = B2PhysicsList, ## what physics list to instantiate
endeventaction_method = endeventaction, ## end event action
sdetectors = [&quot;Chamber_LV+&quot; =&gt; chamber_SD] ## mapping of LVs to SDs (+ means multiple LVs with same name)
)</code></pre><pre><code class="nohighlight hljs">Geant4.G4JLApplication{Main.var&quot;##230&quot;.B2aDetector, Geant4.G4JLNoData}(Geant4.G4RunManagerAllocated(Ptr{Nothing} @0x0000000003555c90), Main.var&quot;##230&quot;.B2aDetector(5, true, 800.0, 200.0, 50.0, 2940.0), [Geant4.G4JLNoData()], Geant4.G4JLGunGenerator(&quot;ParticleGun&quot;, Geant4.G4JLParticleGunData(nothing, &quot;proton&quot;, G4ThreeVector(0.0,0.0,1.0), G4ThreeVector(0.0,0.0,-2940.0), 3000.0), Geant4.var&quot;#init#19&quot;(), Geant4.var&quot;#gen#20&quot;(), Geant4.G4JLGeneratorAction[]), nothing, nothing, 0, 0, Geant4.G4RunManager, Geant4.G4JLDetectorConstruction, Main.var&quot;##230&quot;.B2PhysicsList, Geant4.G4JLRunAction, Geant4.G4JLEventAction, Geant4.G4JLTrackingAction, Geant4.G4JLSteppingAction, nothing, nothing, nothing, nothing, nothing, nothing, Main.var&quot;##230&quot;.endeventaction, nothing, nothing, Dict{String, Geant4.G4JLProtoSD}(&quot;Chamber_LV+&quot; =&gt; Geant4.G4JLProtoSD{Main.var&quot;##230&quot;.B2aSDData}(&quot;Chamber_SD&quot;, Main.var&quot;##230&quot;.B2aSDData(Main.var&quot;##230&quot;.TrackerHit[]), Main.var&quot;##230&quot;._processHits, Main.var&quot;##230&quot;._initialize, Main.var&quot;##230&quot;._endOfEvent)), Dict{String, Vector{Geant4.G4JLSensitiveDetector}}(), Geant4.G4JLScoringMesh[], nothing, nothing)</code></pre><h2 id="Configure,-Initialize-and-Run"><a class="docs-heading-anchor" href="#Configure,-Initialize-and-Run">Configure, Initialize and Run</a><a id="Configure,-Initialize-and-Run-1"></a><a class="docs-heading-anchor-permalink" href="#Configure,-Initialize-and-Run" title="Permalink"></a></h2><pre><code class="language-julia hljs">configure(app)
)</code></pre><pre><code class="nohighlight hljs">Geant4.G4JLApplication{Main.var&quot;##230&quot;.B2aDetector, Geant4.G4JLNoData}(Geant4.G4RunManagerAllocated(Ptr{Nothing} @0x000000000358afd0), Main.var&quot;##230&quot;.B2aDetector(5, true, 800.0, 200.0, 50.0, 2940.0), [Geant4.G4JLNoData()], Geant4.G4JLGunGenerator(&quot;ParticleGun&quot;, Geant4.G4JLParticleGunData(nothing, &quot;proton&quot;, G4ThreeVector(0.0,0.0,1.0), G4ThreeVector(0.0,0.0,-2940.0), 3000.0), Geant4.var&quot;#init#19&quot;(), Geant4.var&quot;#gen#20&quot;(), Geant4.G4JLGeneratorAction[]), nothing, nothing, 0, 0, Geant4.G4RunManager, Geant4.G4JLDetectorConstruction, Main.var&quot;##230&quot;.B2PhysicsList, Geant4.G4JLRunAction, Geant4.G4JLEventAction, Geant4.G4JLTrackingAction, Geant4.G4JLSteppingAction, nothing, nothing, nothing, nothing, nothing, nothing, Main.var&quot;##230&quot;.endeventaction, nothing, nothing, Dict{String, Geant4.G4JLProtoSD}(&quot;Chamber_LV+&quot; =&gt; Geant4.G4JLProtoSD{Main.var&quot;##230&quot;.B2aSDData}(&quot;Chamber_SD&quot;, Main.var&quot;##230&quot;.B2aSDData(Main.var&quot;##230&quot;.TrackerHit[]), Main.var&quot;##230&quot;._processHits, Main.var&quot;##230&quot;._initialize, Main.var&quot;##230&quot;._endOfEvent)), Dict{String, Vector{Geant4.G4JLSensitiveDetector}}(), Geant4.G4JLScoringMesh[], nothing, nothing)</code></pre><h2 id="Configure,-Initialize-and-Run"><a class="docs-heading-anchor" href="#Configure,-Initialize-and-Run">Configure, Initialize and Run</a><a id="Configure,-Initialize-and-Run-1"></a><a class="docs-heading-anchor-permalink" href="#Configure,-Initialize-and-Run" title="Permalink"></a></h2><pre><code class="language-julia hljs">configure(app)
initialize(app)</code></pre><pre><code class="nohighlight hljs">Checking overlaps for volume Target:0 (G4Tubs) ... OK!
Checking overlaps for volume Tracker:0 (G4Tubs) ... OK!
Checking overlaps for volume Chamber_PV:1 (G4Tubs) ... OK!
Expand All @@ -77,4 +77,4 @@
Event: 7 with 10110 hits stored in this event
Event: 8 with 27 hits stored in this event
Event: 9 with 202 hits stored in this event
</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../B1/">« Basic/B1 Example</a><a class="docs-footer-nextpage" href="../B2aVis/">Basic/B2a Event Display Example »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 12:36">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../B1/">« Basic/B1 Example</a><a class="docs-footer-nextpage" href="../B2aVis/">Basic/B2a Event Display Example »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 13:29">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/examples/B2aDetector/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,4 @@
return worldPV
end

Geant4.getConstructor(::B2aDetector)::Function = B2aConstruct</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../JuliaAction/">« Calling G4 actions in Julia</a><a class="docs-footer-nextpage" href="../B2aVisSettings/">B2aVisSettings.jl »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 12:36">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Geant4.getConstructor(::B2aDetector)::Function = B2aConstruct</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../JuliaAction/">« Calling G4 actions in Julia</a><a class="docs-footer-nextpage" href="../B2aVisSettings/">B2aVisSettings.jl »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 13:29">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit be11649

Please sign in to comment.