Deploy documentation

legend-exp · Nov 27, 2024 · eb3f290 · eb3f290
1 parent b40a05d
commit eb3f290
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 21 deletions.
diff --git a/config/index.html b/config/index.html
diff --git a/index.html b/index.html
diff --git a/inputs/index.html b/inputs/index.html
diff --git a/installation/index.html b/installation/index.html
@@ -1,6 +1,4 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>First steps · ZeroNuFit.jl</title><meta name="title" content="First steps · ZeroNuFit.jl"/><meta property="og:title" content="First steps · ZeroNuFit.jl"/><meta property="twitter:title" content="First steps · ZeroNuFit.jl"/><meta name="description" content="Documentation for ZeroNuFit.jl."/><meta property="og:description" content="Documentation for ZeroNuFit.jl."/><meta property="twitter:description" content="Documentation for ZeroNuFit.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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">ZeroNuFit.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>First steps</a><ul class="internal"><li><a class="tocitem" href="#How-to-run-the-code"><span>How to run the code</span></a></li><li><a class="tocitem" href="#Julia-Project-enviroments"><span>Julia Project enviroments</span></a></li></ul></li><li><a class="tocitem" href="../config/">Configuration file</a></li><li><a class="tocitem" href="../inputs/">Partitions and events</a></li><li><a class="tocitem" href="../toys/">Generating toys</a></li><li><a class="tocitem" href="../tutorial/">Tutorial</a></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>First steps</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>First steps</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/sofia-calgaro/ZeroNuFit.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/sofia-calgaro/ZeroNuFit.jl/blob/main/docs/src/installation.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="First-steps"><a class="docs-heading-anchor" href="#First-steps">First steps</a><a id="First-steps-1"></a><a class="docs-heading-anchor-permalink" href="#First-steps" title="Permalink"></a></h1><h2 id="How-to-run-the-code"><a class="docs-heading-anchor" href="#How-to-run-the-code">How to run the code</a><a id="How-to-run-the-code-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-run-the-code" title="Permalink"></a></h2><p>Run the following command by specifying the path to the configuration file used for settings:</p><pre><code class="nohighlight hljs">julia main.jl -c config/config.json</code></pre><h2 id="Julia-Project-enviroments"><a class="docs-heading-anchor" href="#Julia-Project-enviroments">Julia Project enviroments</a><a id="Julia-Project-enviroments-1"></a><a class="docs-heading-anchor-permalink" href="#Julia-Project-enviroments" title="Permalink"></a></h2><p>To run the code in a virtual enviroment you can use the following.</p><pre><code class="nohighlight hljs">julia
-] 
-activate .
-instantiate
-</code></pre><p>Now you can run the script inside this enviroment with:</p><pre><code class="nohighlight hljs">julia main.jl --project=. -c config/config.json</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>The tool was developed for the LEGEND experiment. People from the LEGEND Collaborations can alternatively run the code within a LEGEND container with <code>julia</code> installed, see <a href="https://github.com/legend-exp/legend-julia-tutorial">this tutorial</a> for more details.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../config/">Configuration file »</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="Tuesday 19 November 2024 06:45">Tuesday 19 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>First steps · ZeroNuFit.jl</title><meta name="title" content="First steps · ZeroNuFit.jl"/><meta property="og:title" content="First steps · ZeroNuFit.jl"/><meta property="twitter:title" content="First steps · ZeroNuFit.jl"/><meta name="description" content="Documentation for ZeroNuFit.jl."/><meta property="og:description" content="Documentation for ZeroNuFit.jl."/><meta property="twitter:description" content="Documentation for ZeroNuFit.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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">ZeroNuFit.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>First steps</a><ul class="internal"><li><a class="tocitem" href="#How-to-run-the-code"><span>How to run the code</span></a></li><li><a class="tocitem" href="#Julia-Project-enviroments"><span>Julia Project enviroments</span></a></li></ul></li><li><a class="tocitem" href="../config/">Configuration file</a></li><li><a class="tocitem" href="../inputs/">Partitions and events</a></li><li><a class="tocitem" href="../toys/">Generating toys</a></li><li><a class="tocitem" href="../tutorial/">Tutorial</a></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>First steps</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>First steps</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/sofia-calgaro/ZeroNuFit.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/sofia-calgaro/ZeroNuFit.jl/blob/main/docs/src/installation.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="First-steps"><a class="docs-heading-anchor" href="#First-steps">First steps</a><a id="First-steps-1"></a><a class="docs-heading-anchor-permalink" href="#First-steps" title="Permalink"></a></h1><h2 id="How-to-run-the-code"><a class="docs-heading-anchor" href="#How-to-run-the-code">How to run the code</a><a id="How-to-run-the-code-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-run-the-code" title="Permalink"></a></h2><p>Run the following command by specifying the path to the configuration file used for settings:</p><pre><code class="nohighlight hljs">$ julia main.jl -c config/config.json</code></pre><h2 id="Julia-Project-enviroments"><a class="docs-heading-anchor" href="#Julia-Project-enviroments">Julia Project enviroments</a><a id="Julia-Project-enviroments-1"></a><a class="docs-heading-anchor-permalink" href="#Julia-Project-enviroments" title="Permalink"></a></h2><p>To run the code in a virtual enviroment you can use the following. Start by entering the Julia command view by typing <code>julia</code> on your terminal. Once inside, enter the packagge manager (via <code>]</code>), activate the environment in the current directory, and resolve (and install, if necessary) dependencies:</p><pre><code class="language-julia hljs">pkg&gt; ] 
+pkg&gt; activate .
+pkg&gt; instantiate</code></pre><p>Now you can run the script inside this enviroment with:</p><pre><code class="nohighlight hljs">$ julia main.jl --project=. -c config/config.json</code></pre><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>The tool was developed for the LEGEND experiment. People from the LEGEND Collaborations can alternatively run the code within a LEGEND container with <code>julia</code> installed, see <a href="https://github.com/legend-exp/legend-julia-tutorial">this tutorial</a> for more details.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../config/">Configuration file »</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 27 November 2024 03:47">Wednesday 27 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/search_index.js b/search_index.js