Skip to content

Commit

Permalink
build based on 348028f
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 18, 2024
1 parent ce3426f commit ddf6517
Show file tree
Hide file tree
Showing 13 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion previews/PR70/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
</head>
<body>
<div id="app"></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"examples.md\":\"DZUwV_Vf\",\"index.md\":\"6qyEUEXO\",\"lib_internal.md\":\"CvJh32j5\",\"lib_public.md\":\"6YQ7Ly5z\",\"lib_visualisation.md\":\"B2M1EABd\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"JetReconstruction.jl\",\"description\":\"Documentation for JetReconstruction.jl\",\"base\":\"/JetReconstruction.jl/previews/PR70/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"editLink\":{\"pattern\":\"https://github.com/JuliaHEP/JetReconstruction.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/JuliaHEP/JetReconstruction.jl\"}],\"footer\":{\"message\":\"Made with <a href=\\\"https://luxdl.github.io/DocumenterVitepress.jl/dev/\\\" target=\\\"_blank\\\"><strong>DocumenterVitepress.jl</strong></a><br>\",\"copyright\":\"© Copyright 2024.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"examples.md\":\"DZUwV_Vf\",\"index.md\":\"6qyEUEXO\",\"lib_internal.md\":\"D-DrIRCp\",\"lib_public.md\":\"B-nZk3oE\",\"lib_visualisation.md\":\"MC0nUn_x\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"JetReconstruction.jl\",\"description\":\"Documentation for JetReconstruction.jl\",\"base\":\"/JetReconstruction.jl/previews/PR70/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"editLink\":{\"pattern\":\"https://github.com/JuliaHEP/JetReconstruction.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/JuliaHEP/JetReconstruction.jl\"}],\"footer\":{\"message\":\"Made with <a href=\\\"https://luxdl.github.io/DocumenterVitepress.jl/dev/\\\" target=\\\"_blank\\\"><strong>DocumenterVitepress.jl</strong></a><br>\",\"copyright\":\"© Copyright 2024.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>

</body>
</html>

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR70/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">...</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">julia</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --project=.</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> examples/jetreco.jl</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --maxevents=100</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --strategy=N2Tiled</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> test/data/events.hepmc3</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">...</span></span></code></pre></div><p>There are options to explicitly set the algorithm (use <code>--help</code> to see these).</p><h2 id="instrumented-jetreco.jl" tabindex="-1"><code>instrumented-jetreco.jl</code> <a class="header-anchor" href="#instrumented-jetreco.jl" aria-label="Permalink to &quot;`instrumented-jetreco.jl` {#instrumented-jetreco.jl}&quot;"></a></h2><p>This is a more sophisticated example that allows performance measurements to be made of the reconstruction, as well as profiling (flamegraphs and memory profiling). Use the <code>--help</code> option to see usage. e.g., to extract timing performance for the AntiKt algorithm using the tiled strategy:</p><div class="language-sh vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">julia</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --project</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> instrumented-jetreco.jl</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -S</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> N2Tiled</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -A</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> AntiKt</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --nsamples</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 100</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ../test/data/events.hepmc3</span></span></code></pre></div><h2 id="visualise-jets.jl" tabindex="-1"><code>visualise-jets.jl</code> <a class="header-anchor" href="#visualise-jets.jl" aria-label="Permalink to &quot;`visualise-jets.jl` {#visualise-jets.jl}&quot;"></a></h2><p>This script will produce a PNG/PDF showing the results of a jet reconstruction. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.</p><h2 id="visualise-jets.ipynb" tabindex="-1"><code>visualise-jets.ipynb</code> <a class="header-anchor" href="#visualise-jets.ipynb" aria-label="Permalink to &quot;`visualise-jets.ipynb` {#visualise-jets.ipynb}&quot;"></a></h2><p>Similar to <code>visualise-jets.jl</code> this notebook will produce a visualisation of jet reconstruction in the browser. This is a 3D plot where all the initial energy deposits are visualised, with colours that indicate in which final cluster the deposit ended up in.</p><h2 id="animate-reconstruction.jl" tabindex="-1"><code>animate-reconstruction.jl</code> <a class="header-anchor" href="#animate-reconstruction.jl" aria-label="Permalink to &quot;`animate-reconstruction.jl` {#animate-reconstruction.jl}&quot;"></a></h2><p>Performs jet reconstruction and then produces and animation of the process, showing how the jets merge from their different constituents.</p></div></div></main><footer class="VPDocFooter" data-v-83890dd9 data-v-4f9813fa><!--[--><!--]--><div class="edit-info" data-v-4f9813fa><div class="edit-link" data-v-4f9813fa><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/JuliaHEP/JetReconstruction.jl/edit/main/docs/src/examples.md" target="_blank" rel="noreferrer" data-v-4f9813fa><!--[--><span class="vpi-square-pen edit-link-icon" data-v-4f9813fa></span> Edit this page<!--]--></a></div><!----></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-4f9813fa><span class="visually-hidden" id="doc-footer-aria-label" data-v-4f9813fa>Pager</span><div class="pager" data-v-4f9813fa><a class="VPLink link pager-link prev" href="/JetReconstruction.jl/previews/PR70/index" data-v-4f9813fa><!--[--><span class="desc" data-v-4f9813fa>Previous page</span><span class="title" data-v-4f9813fa>Home</span><!--]--></a></div><div class="pager" data-v-4f9813fa><a class="VPLink link pager-link next" href="/JetReconstruction.jl/previews/PR70/lib/public" data-v-4f9813fa><!--[--><span class="desc" data-v-4f9813fa>Next page</span><span class="title" data-v-4f9813fa>Public API</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-a9a9e638 data-v-c970a860><div class="container" data-v-c970a860><p class="message" data-v-c970a860>Made with <a href="https://luxdl.github.io/DocumenterVitepress.jl/dev/" target="_blank"><strong>DocumenterVitepress.jl</strong></a><br></p><p class="copyright" data-v-c970a860>© Copyright 2024.</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"examples.md\":\"DZUwV_Vf\",\"index.md\":\"6qyEUEXO\",\"lib_internal.md\":\"CvJh32j5\",\"lib_public.md\":\"6YQ7Ly5z\",\"lib_visualisation.md\":\"B2M1EABd\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"JetReconstruction.jl\",\"description\":\"Documentation for JetReconstruction.jl\",\"base\":\"/JetReconstruction.jl/previews/PR70/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"editLink\":{\"pattern\":\"https://github.com/JuliaHEP/JetReconstruction.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/JuliaHEP/JetReconstruction.jl\"}],\"footer\":{\"message\":\"Made with <a href=\\\"https://luxdl.github.io/DocumenterVitepress.jl/dev/\\\" target=\\\"_blank\\\"><strong>DocumenterVitepress.jl</strong></a><br>\",\"copyright\":\"© Copyright 2024.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"examples.md\":\"DZUwV_Vf\",\"index.md\":\"6qyEUEXO\",\"lib_internal.md\":\"D-DrIRCp\",\"lib_public.md\":\"B-nZk3oE\",\"lib_visualisation.md\":\"MC0nUn_x\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"JetReconstruction.jl\",\"description\":\"Documentation for JetReconstruction.jl\",\"base\":\"/JetReconstruction.jl/previews/PR70/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"editLink\":{\"pattern\":\"https://github.com/JuliaHEP/JetReconstruction.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/JuliaHEP/JetReconstruction.jl\"}],\"footer\":{\"message\":\"Made with <a href=\\\"https://luxdl.github.io/DocumenterVitepress.jl/dev/\\\" target=\\\"_blank\\\"><strong>DocumenterVitepress.jl</strong></a><br>\",\"copyright\":\"© Copyright 2024.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>

</body>
</html>
2 changes: 1 addition & 1 deletion previews/PR70/hashmap.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"examples.md":"DZUwV_Vf","index.md":"6qyEUEXO","lib_internal.md":"CvJh32j5","lib_public.md":"6YQ7Ly5z","lib_visualisation.md":"B2M1EABd"}
{"examples.md":"DZUwV_Vf","index.md":"6qyEUEXO","lib_internal.md":"D-DrIRCp","lib_public.md":"B-nZk3oE","lib_visualisation.md":"MC0nUn_x"}
2 changes: 1 addition & 1 deletion previews/PR70/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> archivePrefix</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">arXiv</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">}</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> primaryClass</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">=</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">hep-ex</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">}</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h2 id="Authors-and-Copyright" tabindex="-1">Authors and Copyright <a class="header-anchor" href="#Authors-and-Copyright" aria-label="Permalink to &quot;Authors and Copyright {#Authors-and-Copyright}&quot;"></a></h2><p>Code in this package is authored by:</p><ul><li><p>Atell Krasnopolski &lt;[email protected]&gt;</p></li><li><p>Graeme A Stewart &lt;[email protected]&gt;</p></li><li><p>Philippe Gras &lt;[email protected]&gt;</p></li></ul><p>and is Copyright 2022-2024 The Authors, CERN.</p><p>The code is under the MIT License.</p></div></div><!--]--></div></div></div><footer class="VPFooter" data-v-a9a9e638 data-v-c970a860><div class="container" data-v-c970a860><p class="message" data-v-c970a860>Made with <a href="https://luxdl.github.io/DocumenterVitepress.jl/dev/" target="_blank"><strong>DocumenterVitepress.jl</strong></a><br></p><p class="copyright" data-v-c970a860>© Copyright 2024.</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"examples.md\":\"DZUwV_Vf\",\"index.md\":\"6qyEUEXO\",\"lib_internal.md\":\"CvJh32j5\",\"lib_public.md\":\"6YQ7Ly5z\",\"lib_visualisation.md\":\"B2M1EABd\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"JetReconstruction.jl\",\"description\":\"Documentation for JetReconstruction.jl\",\"base\":\"/JetReconstruction.jl/previews/PR70/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"editLink\":{\"pattern\":\"https://github.com/JuliaHEP/JetReconstruction.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/JuliaHEP/JetReconstruction.jl\"}],\"footer\":{\"message\":\"Made with <a href=\\\"https://luxdl.github.io/DocumenterVitepress.jl/dev/\\\" target=\\\"_blank\\\"><strong>DocumenterVitepress.jl</strong></a><br>\",\"copyright\":\"© Copyright 2024.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"examples.md\":\"DZUwV_Vf\",\"index.md\":\"6qyEUEXO\",\"lib_internal.md\":\"D-DrIRCp\",\"lib_public.md\":\"B-nZk3oE\",\"lib_visualisation.md\":\"MC0nUn_x\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"JetReconstruction.jl\",\"description\":\"Documentation for JetReconstruction.jl\",\"base\":\"/JetReconstruction.jl/previews/PR70/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":\"deep\",\"logo\":{\"src\":\"/logo.png\",\"width\":24,\"height\":24},\"search\":{\"provider\":\"local\",\"options\":{\"detailedView\":true}},\"nav\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"sidebar\":[{\"text\":\"Home\",\"link\":\"/index\"},{\"text\":\"Examples\",\"link\":\"/examples\"},{\"text\":\"Reference\",\"collapsed\":false,\"items\":[{\"text\":\"Public API\",\"link\":\"/lib/public\"},{\"text\":\"Internal API\",\"link\":\"/lib/internal\"},{\"text\":\"Visualisation API\",\"link\":\"/lib/visualisation\"}]}],\"editLink\":{\"pattern\":\"https://github.com/JuliaHEP/JetReconstruction.jl/edit/main/docs/src/:path\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/JuliaHEP/JetReconstruction.jl\"}],\"footer\":{\"message\":\"Made with <a href=\\\"https://luxdl.github.io/DocumenterVitepress.jl/dev/\\\" target=\\\"_blank\\\"><strong>DocumenterVitepress.jl</strong></a><br>\",\"copyright\":\"© Copyright 2024.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>

</body>
</html>
Loading

0 comments on commit ddf6517

Please sign in to comment.