build based on 350b64c

Author: Documenter.jl

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-29T07:31:57","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-29T09:11:53","documenter_version":"1.5.0"}}

dev/api.html

@@ -18,4 +18,4 @@
   booktitle={Proceedings of the Fourth ACM International Conference on AI in Finance},
   pages={305--313},
   year={2023}
-}</code></pre><h2 id="Disclaimer"><a class="docs-heading-anchor" href="#Disclaimer">Disclaimer</a><a id="Disclaimer-1"></a><a class="docs-heading-anchor-permalink" href="#Disclaimer" title="Permalink"></a></h2><p>This package is an outcome of a research project. All errors are those of the authors. All views expressed are personal views, not those of Bank of Italy.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="examples/basic_example.html">Essentials »</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="Monday 29 July 2024 07:31">Monday 29 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="Disclaimer"><a class="docs-heading-anchor" href="#Disclaimer">Disclaimer</a><a id="Disclaimer-1"></a><a class="docs-heading-anchor-permalink" href="#Disclaimer" title="Permalink"></a></h2><p>This package is an outcome of a research project. All errors are those of the authors. All views expressed are personal views, not those of Bank of Italy.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="examples/basic_example.html">Essentials »</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="Monday 29 July 2024 09:11">Monday 29 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/examples/basic_example-75bbaf1c.svg

@@ -1,4 +1,4 @@
 <!DOCTYPE html>
 <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Runs from the terminal · ABCredit.jl</title><meta name="title" content="Runs from the terminal · ABCredit.jl"/><meta property="og:title" content="Runs from the terminal · ABCredit.jl"/><meta property="twitter:title" content="Runs from the terminal · ABCredit.jl"/><meta name="description" content="Documentation for ABCredit.jl."/><meta property="og:description" content="Documentation for ABCredit.jl."/><meta property="twitter:description" content="Documentation for ABCredit.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="index.html"><img src="assets/logo.png" alt="ABCredit.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">ABCredit.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="index.html">Home</a></li><li><a class="tocitem" href="examples/basic_example.html">Essentials</a></li><li><a class="tocitem" href="examples/parallel_evaluations.html">Parallel evaluations</a></li><li class="is-active"><a class="tocitem" href="running_from_terminal.html">Runs from the terminal</a><ul class="internal"><li><a class="tocitem" href="#Reduce-overhead-by-generating-of-a-sysimage-file"><span>Reduce overhead by generating of a sysimage file</span></a></li></ul></li><li><a class="tocitem" href="api.html">Code reference</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="running_from_terminal.html">Runs from the terminal</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="running_from_terminal.html">Runs from the terminal</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/bancaditalia/ABCredit.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/bancaditalia/ABCredit.jl/blob/main/docs/src/running_from_terminal.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="Running-the-model-from-the-terminal"><a class="docs-heading-anchor" href="#Running-the-model-from-the-terminal">Running the model from the terminal</a><a id="Running-the-model-from-the-terminal-1"></a><a class="docs-heading-anchor-permalink" href="#Running-the-model-from-the-terminal" title="Permalink"></a></h1><p>You can run the model from the terminal without activating the Julia environment via</p><pre><code class="language-shell hljs">julia --project=. main.jl</code></pre><p>The <code>main.jl</code> runs the model with a set of standard parameter, if you want to specify a different set of parameters directly from the command line you can run</p><pre><code class="language-shell hljs">julia --project=. main_st_in_out.jl par1 par2 ... par33</code></pre><p>the results of the run will be saved in a CSV. Check the <code>main_st_in_out.jl</code> file for details.</p><p>If you need to call the model many times with a different set of parameters e.g., if you want to calibrate it using <a href="https://github.com/bancaditalia/black-it">Black-it</a>, you might want to generate a Julia &quot;sysimage&quot; of the project to avoid the overhead caused by loading Julia libraries and compiling the code every time you run the code.</p><h2 id="Reduce-overhead-by-generating-of-a-sysimage-file"><a class="docs-heading-anchor" href="#Reduce-overhead-by-generating-of-a-sysimage-file">Reduce overhead by generating of a sysimage file</a><a id="Reduce-overhead-by-generating-of-a-sysimage-file-1"></a><a class="docs-heading-anchor-permalink" href="#Reduce-overhead-by-generating-of-a-sysimage-file" title="Permalink"></a></h2><p>First activate the Julia environment</p><pre><code class="language-shell hljs">julia --project=.</code></pre><p>then run the following three lines</p><pre><code class="language-julia hljs">using PackageCompiler
 packages = [:StatsBase]
-create_sysimage(packages, sysimage_path=&quot;ABCreditjl.so&quot;, precompile_execution_file=&quot;main.jl&quot;)</code></pre><p>The execution of the last line should a few minutes and will generate the sysfile named &quot;ABCreditjl.so&quot;, with such a file you can run the model with a lower overhead as</p><pre><code class="language-shell hljs">julia --sysimage ABCreditjl.so main_st_in_out.jl par1 par2 ... par33</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="examples/parallel_evaluations.html">« Parallel evaluations</a><a class="docs-footer-nextpage" href="api.html">Code reference »</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="Monday 29 July 2024 07:31">Monday 29 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+create_sysimage(packages, sysimage_path=&quot;ABCreditjl.so&quot;, precompile_execution_file=&quot;main.jl&quot;)</code></pre><p>The execution of the last line should a few minutes and will generate the sysfile named &quot;ABCreditjl.so&quot;, with such a file you can run the model with a lower overhead as</p><pre><code class="language-shell hljs">julia --sysimage ABCreditjl.so main_st_in_out.jl par1 par2 ... par33</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="examples/parallel_evaluations.html">« Parallel evaluations</a><a class="docs-footer-nextpage" href="api.html">Code reference »</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="Monday 29 July 2024 09:11">Monday 29 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>