Skip to content

Commit

Permalink
build based on 3739cce
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 16, 2024
1 parent ccf6a92 commit 685bbe8
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 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.10.4","generation_timestamp":"2024-07-16T11:34:41","documenter_version":"1.5.0"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-16T12:23:57","documenter_version":"1.5.0"}}
2 changes: 1 addition & 1 deletion dev/examples/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Examples · JetReconstruction.jl</title><meta name="title" content="Examples · JetReconstruction.jl"/><meta property="og:title" content="Examples · JetReconstruction.jl"/><meta property="twitter:title" content="Examples · JetReconstruction.jl"/><meta name="description" content="Documentation for JetReconstruction.jl."/><meta property="og:description" content="Documentation for JetReconstruction.jl."/><meta property="twitter:description" content="Documentation for JetReconstruction.jl."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="JetReconstruction.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">JetReconstruction.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>Examples</a><ul class="internal"><li><a class="tocitem" href="#jetreco.jl"><span><code>jetreco.jl</code></span></a></li><li><a class="tocitem" href="#instrumented-jetreco.jl"><span><code>instrumented-jetreco.jl</code></span></a></li><li><a class="tocitem" href="#visualise-jets.jl"><span><code>visualise-jets.jl</code></span></a></li><li><a class="tocitem" href="#visualise-jets.ipynb"><span><code>visualise-jets.ipynb</code></span></a></li><li><a class="tocitem" href="#animate-reconstruction.jl"><span><code>animate-reconstruction.jl</code></span></a></li></ul></li><li><span class="tocitem">Reference</span><ul><li><a class="tocitem" href="../lib/public/">Public API</a></li><li><a class="tocitem" href="../lib/internal/">Internal API</a></li><li><a class="tocitem" href="../lib/visualisation/">Visualisation API</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Examples</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Examples</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaHEP/JetReconstruction.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaHEP/JetReconstruction.jl/blob/main/docs/src/examples.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Jet-Reconstruction-Examples"><a class="docs-heading-anchor" href="#Jet-Reconstruction-Examples">Jet Reconstruction Examples</a><a id="Jet-Reconstruction-Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Jet-Reconstruction-Examples" title="Permalink"></a></h1><p>The Jet Reconstruction package has a number of example files that show how to usage.</p><p><em>Note:</em> because of extra dependencies in these scripts, one must use the <code>Project.toml</code> file in the <code>examples</code> directory.</p><h2 id="jetreco.jl"><a class="docs-heading-anchor" href="#jetreco.jl"><code>jetreco.jl</code></a><a id="jetreco.jl-1"></a><a class="docs-heading-anchor-permalink" href="#jetreco.jl" title="Permalink"></a></h2><p>This is a basic jet reconstruction example that shows how to call the package to perform a jet reconstruction, with different algorithms and (optionally) strategy, producing exclusive and inclusive jet selections.</p><pre><code class="language-sh hljs">julia --project=. examples/jetreco.jl --maxevents=100 --strategy=N2Plain test/data/events.hepmc3
...
julia --project=. examples/jetreco.jl --maxevents=100 --strategy=N2Tiled test/data/events.hepmc3
...</code></pre><p>There are options to explicitly set the algorithm (use <code>--help</code> to see these).</p><h2 id="instrumented-jetreco.jl"><a class="docs-heading-anchor" href="#instrumented-jetreco.jl"><code>instrumented-jetreco.jl</code></a><a id="instrumented-jetreco.jl-1"></a><a class="docs-heading-anchor-permalink" href="#instrumented-jetreco.jl" title="Permalink"></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><pre><code class="language-sh hljs">julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.hepmc3</code></pre><h2 id="visualise-jets.jl"><a class="docs-heading-anchor" href="#visualise-jets.jl"><code>visualise-jets.jl</code></a><a id="visualise-jets.jl-1"></a><a class="docs-heading-anchor-permalink" href="#visualise-jets.jl" title="Permalink"></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"><a class="docs-heading-anchor" href="#visualise-jets.ipynb"><code>visualise-jets.ipynb</code></a><a id="visualise-jets.ipynb-1"></a><a class="docs-heading-anchor-permalink" href="#visualise-jets.ipynb" title="Permalink"></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"><a class="docs-heading-anchor" href="#animate-reconstruction.jl"><code>animate-reconstruction.jl</code></a><a id="animate-reconstruction.jl-1"></a><a class="docs-heading-anchor-permalink" href="#animate-reconstruction.jl" title="Permalink"></a></h2><p>Performs jet reconstruction and then produces and animation of the process, showing how the jets merge from their different constituents.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../lib/public/">Public API »</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.5.0 on <span class="colophon-date" title="Tuesday 16 July 2024 11:34">Tuesday 16 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
...</code></pre><p>There are options to explicitly set the algorithm (use <code>--help</code> to see these).</p><h2 id="instrumented-jetreco.jl"><a class="docs-heading-anchor" href="#instrumented-jetreco.jl"><code>instrumented-jetreco.jl</code></a><a id="instrumented-jetreco.jl-1"></a><a class="docs-heading-anchor-permalink" href="#instrumented-jetreco.jl" title="Permalink"></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><pre><code class="language-sh hljs">julia --project instrumented-jetreco.jl -S N2Tiled -A AntiKt --nsamples 100 ../test/data/events.hepmc3</code></pre><h2 id="visualise-jets.jl"><a class="docs-heading-anchor" href="#visualise-jets.jl"><code>visualise-jets.jl</code></a><a id="visualise-jets.jl-1"></a><a class="docs-heading-anchor-permalink" href="#visualise-jets.jl" title="Permalink"></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"><a class="docs-heading-anchor" href="#visualise-jets.ipynb"><code>visualise-jets.ipynb</code></a><a id="visualise-jets.ipynb-1"></a><a class="docs-heading-anchor-permalink" href="#visualise-jets.ipynb" title="Permalink"></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"><a class="docs-heading-anchor" href="#animate-reconstruction.jl"><code>animate-reconstruction.jl</code></a><a id="animate-reconstruction.jl-1"></a><a class="docs-heading-anchor-permalink" href="#animate-reconstruction.jl" title="Permalink"></a></h2><p>Performs jet reconstruction and then produces and animation of the process, showing how the jets merge from their different constituents.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../lib/public/">Public API »</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.5.0 on <span class="colophon-date" title="Tuesday 16 July 2024 12:23">Tuesday 16 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
eprint={2309.17309},
archivePrefix={arXiv},
primaryClass={hep-ex}
}</code></pre><h2 id="Authors-and-Copyright"><a class="docs-heading-anchor" href="#Authors-and-Copyright">Authors and Copyright</a><a id="Authors-and-Copyright-1"></a><a class="docs-heading-anchor-permalink" href="#Authors-and-Copyright" title="Permalink"></a></h2><p>Code in this package is authored by:</p><ul><li>Atell Krasnopolski &lt;[email protected]&gt;</li><li>Graeme A Stewart &lt;[email protected]&gt;</li><li>Philippe Gras &lt;[email protected]&gt;</li></ul><p>and is Copyright 2022-2024 The Authors, CERN.</p><p>The code is under the MIT License.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="examples/">Examples »</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.5.0 on <span class="colophon-date" title="Tuesday 16 July 2024 11:34">Tuesday 16 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
}</code></pre><h2 id="Authors-and-Copyright"><a class="docs-heading-anchor" href="#Authors-and-Copyright">Authors and Copyright</a><a id="Authors-and-Copyright-1"></a><a class="docs-heading-anchor-permalink" href="#Authors-and-Copyright" title="Permalink"></a></h2><p>Code in this package is authored by:</p><ul><li>Atell Krasnopolski &lt;[email protected]&gt;</li><li>Graeme A Stewart &lt;[email protected]&gt;</li><li>Philippe Gras &lt;[email protected]&gt;</li></ul><p>and is Copyright 2022-2024 The Authors, CERN.</p><p>The code is under the MIT License.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="examples/">Examples »</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.5.0 on <span class="colophon-date" title="Tuesday 16 July 2024 12:23">Tuesday 16 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
8 changes: 4 additions & 4 deletions dev/lib/internal/index.html
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 685bbe8

Please sign in to comment.