build based on 753498d

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-05T06:09:54","documenter_version":"1.2.1"}}
+{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-02-06T01:50:38","documenter_version":"1.2.1"}}

dev/index.html

@@ -10,7 +10,7 @@
   (0.014539731,0.05663412,-0.32755017)
 
 julia> sum(mcparticles[5:8].momentum)
-  (1.7487122,0.0,-0.11407688)</code></pre></li></ul><h2 id="Roadmap"><a class="docs-heading-anchor" href="#Roadmap">Roadmap</a><a id="Roadmap-1"></a><a class="docs-heading-anchor-permalink" href="#Roadmap" title="Permalink"></a></h2><p>There are a number of issues and problems still to be resolved. We keep track of them in this list:</p><ul><li>Need to generate and support <code>VectorMembers</code>. For the time being are ignored. - <em>DONE</em></li><li>Handle cyclic datatype dependencies. In EDM4hep there is one case that is not yet resolved. <code>Vertex</code> depends on <code>ReconstructedParticle</code> in a one-to-one relation and <code>ReconstructedParticle</code> relates to <code>Vertex</code>. Using the abstract class <code>POD</code> in this case works well to break the cycle. - <em>DONE</em> </li><li>Better handle collectionID in one-to-many relations - <em>DONE</em></li><li>Be able to read RNTuple files in addition to TTree files - <em>DONE</em></li><li>Generate doc string with member information - <em>DONE</em></li><li>Generate accessors for one-to-many relations, vector members</li><li>Support latest version (RC2) of RNTuple format (waiting for a file being generated)</li></ul><h2 id="Tests"><a class="docs-heading-anchor" href="#Tests">Tests</a><a id="Tests-1"></a><a class="docs-heading-anchor-permalink" href="#Tests" title="Permalink"></a></h2><p>Unit tests can be run with <code>julia --project=. test/runtests.jl</code></p><h2 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h2><h3 id="examples/mcparticle_tree.jl"><a class="docs-heading-anchor" href="#examples/mcparticle_tree.jl">examples/mcparticle_tree.jl</a><a id="examples/mcparticle_tree.jl-1"></a><a class="docs-heading-anchor-permalink" href="#examples/mcparticle_tree.jl" title="Permalink"></a></h3><p>Creates a collection of <code>MCParticles</code> and a collection of <code>SimTrackerHits</code> in memory, constructing the relations between particle <code>parents</code> and <code>daughters</code>, as well as, the the one-to-one relation between the simulation hit to the originator <code>MCParticle</code>.</p><h3 id="examples/read_example.jl"><a class="docs-heading-anchor" href="#examples/read_example.jl">examples/read_example.jl</a><a id="examples/read_example.jl-1"></a><a class="docs-heading-anchor-permalink" href="#examples/read_example.jl" title="Permalink"></a></h3><p>An example of reading from a ROOT file created by the C++ implementation of EDM4hep. This is the full code:</p><pre><code class="language-julia hljs">using EDM4hep
+  (1.7487122,0.0,-0.11407688)</code></pre></li></ul><h2 id="Roadmap"><a class="docs-heading-anchor" href="#Roadmap">Roadmap</a><a id="Roadmap-1"></a><a class="docs-heading-anchor-permalink" href="#Roadmap" title="Permalink"></a></h2><p>There are a number of issues and problems still to be resolved. We keep track of them in this list:</p><ul><li>Need to generate and support <code>VectorMembers</code>. For the time being are ignored. - <em>DONE</em></li><li>Handle cyclic datatype dependencies. In EDM4hep there is one case that is not yet resolved. <code>Vertex</code> depends on <code>ReconstructedParticle</code> in a one-to-one relation and <code>ReconstructedParticle</code> relates to <code>Vertex</code>. Using the abstract class <code>POD</code> in this case works well to break the cycle. - <em>DONE</em> </li><li>Better handle collectionID in one-to-many relations - <em>DONE</em></li><li>Be able to read RNTuple files in addition to TTree files - <em>DONE</em></li><li>Generate doc string with member information - <em>DONE</em></li><li>Generate accessors for one-to-many relations, vector members - <em>DONE</em> </li><li>Support latest version (RC2) of RNTuple format (waiting for a file being generated)</li></ul><h2 id="Tests"><a class="docs-heading-anchor" href="#Tests">Tests</a><a id="Tests-1"></a><a class="docs-heading-anchor-permalink" href="#Tests" title="Permalink"></a></h2><p>Unit tests can be run with <code>julia --project=. test/runtests.jl</code></p><h2 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h2><h3 id="examples/mcparticle_tree.jl"><a class="docs-heading-anchor" href="#examples/mcparticle_tree.jl">examples/mcparticle_tree.jl</a><a id="examples/mcparticle_tree.jl-1"></a><a class="docs-heading-anchor-permalink" href="#examples/mcparticle_tree.jl" title="Permalink"></a></h3><p>Creates a collection of <code>MCParticles</code> and a collection of <code>SimTrackerHits</code> in memory, constructing the relations between particle <code>parents</code> and <code>daughters</code>, as well as, the the one-to-one relation between the simulation hit to the originator <code>MCParticle</code>.</p><h3 id="examples/read_example.jl"><a class="docs-heading-anchor" href="#examples/read_example.jl">examples/read_example.jl</a><a id="examples/read_example.jl-1"></a><a class="docs-heading-anchor-permalink" href="#examples/read_example.jl" title="Permalink"></a></h3><p>An example of reading from a ROOT file created by the C++ implementation of EDM4hep. This is the full code:</p><pre><code class="language-julia hljs">using EDM4hep
 using EDM4hep.RootIO
 
 cd(@__DIR__)
@@ -36,4 +36,4 @@
             println(&quot;      ---&gt; $(m.index) $(m.name)&quot;)
         end 
     end
-end</code></pre><h2 id="EDM4hep-Data-Model"><a class="docs-heading-anchor" href="#EDM4hep-Data-Model">EDM4hep Data Model</a><a id="EDM4hep-Data-Model-1"></a><a class="docs-heading-anchor-permalink" href="#EDM4hep-Data-Model" title="Permalink"></a></h2><p>This is the diagram for the EDM4hep datamodel including relationships. </p><p><img src="assets/edm4hep_diagram.svg" alt="Figure"/></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">Public APIs »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Monday 5 February 2024 06:09">Monday 5 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><h2 id="EDM4hep-Data-Model"><a class="docs-heading-anchor" href="#EDM4hep-Data-Model">EDM4hep Data Model</a><a id="EDM4hep-Data-Model-1"></a><a class="docs-heading-anchor-permalink" href="#EDM4hep-Data-Model" title="Permalink"></a></h2><p>This is the diagram for the EDM4hep datamodel including relationships. </p><p><img src="assets/edm4hep_diagram.svg" alt="Figure"/></p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">Public APIs »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Tuesday 6 February 2024 01:50">Tuesday 6 February 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>