build based on 0bdf7bd

Author: Documenter.jl

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.7","generation_timestamp":"2024-12-23T14:59:24","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.10.8","generation_timestamp":"2025-02-09T12:30:17","documenter_version":"1.8.0"}}

dev/api.html

@@ -31,4 +31,4 @@
         ".jld2",
         init_conds,
     )
-end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="multithreading_speedup.html">« Multithreading within the model</a><a class="docs-footer-nextpage" href="../api.html">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.8.0 on <span class="colophon-date" title="Monday 23 December 2024 14:59">Monday 23 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="multithreading_speedup.html">« Multithreading within the model</a><a class="docs-footer-nextpage" href="../api.html">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.8.0 on <span class="colophon-date" title="Sunday 9 February 2025 12:30">Sunday 9 February 2025</span>. Using Julia version 1.10.8.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/examples/basic_example-1141b5a5.svg

@@ -3,9 +3,9 @@
 using FileIO, Plots, StatsPlots</code></pre><p>First, we initialise the model, this time we use the Italy 2010Q1 scenario, and we want to simulate the model for a large number of epochs</p><pre><code class="language-julia hljs">parameters = Bit.ITALY2010Q1.parameters
 initial_conditions = Bit.ITALY2010Q1.initial_conditions
 T = 50
-model = Bit.init_model(parameters, initial_conditions, T);</code></pre><p>The model is in scale 1:2000, so it has around 30,000 households</p><pre><code class="language-julia hljs">model.prop.H</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">29915</code></pre><p>Note that the households number is actually the sum of active and inactive households, the owners of firms and of the bank</p><pre><code class="language-julia hljs">length(model.w_act) + length(model.w_inact) + length(model.firms) + 1</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">29915</code></pre><p>Let&#39;s fist check how many threads we have available in this Julia session</p><pre><code class="language-julia hljs">Threads.nthreads()</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">2</code></pre><p>Then we need to first compile the code not to count compilation time, we can do that just by executing the function one time</p><pre><code class="language-julia hljs">Bit.run_one_sim!(model; multi_threading = false);</code></pre><p>Let&#39;s now compare the performance of single threading and multi threading</p><pre><code class="language-julia hljs">model = Bit.init_model(parameters, initial_conditions, T);
-@time data = Bit.run_one_sim!(model; multi_threading = false);
+model = Bit.init_model(parameters, initial_conditions, T);</code></pre><p>The model is in scale 1:2000, so it has around 30,000 households</p><pre><code class="language-julia hljs">model.prop.H</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">29915</code></pre><p>Note that the households number is actually the sum of active and inactive households, the owners of firms and of the bank</p><pre><code class="language-julia hljs">length(model.w_act) + length(model.w_inact) + length(model.firms) + 1</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">29915</code></pre><p>Let&#39;s fist check how many threads we have available in this Julia session</p><pre><code class="language-julia hljs">Threads.nthreads()</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">2</code></pre><p>Then we need to first compile the code not to count compilation time, we can do that just by executing the function one time</p><pre><code class="language-julia hljs">Bit.run!(model; multi_threading = false);</code></pre><p>Let&#39;s now compare the performance of single threading and multi threading</p><pre><code class="language-julia hljs">model = Bit.init_model(parameters, initial_conditions, T);
+@time data = Bit.run!(model; multi_threading = false);
 
 model = Bit.init_model(parameters, initial_conditions, T);
-@time data = Bit.run_one_sim!(model; multi_threading = true);</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">  5.702206 seconds (3.42 M allocations: 6.010 GiB, 20.83% gc time)
-  2.719377 seconds (3.49 M allocations: 6.254 GiB, 8.82% gc time)</code></pre><p>Is the speedup in line to what we would expect? Yes!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="change_expectations.html">« Experimentations (advanced)</a><a class="docs-footer-nextpage" href="get_parameters_and_initial_conditions.html">Calibration »</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="Monday 23 December 2024 14:59">Monday 23 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+@time data = Bit.run!(model; multi_threading = true);</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">  5.705671 seconds (3.42 M allocations: 6.010 GiB, 20.57% gc time)
+  2.930004 seconds (3.49 M allocations: 6.254 GiB, 14.59% gc time)</code></pre><p>Is the speedup in line to what we would expect? Yes!</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="change_expectations.html">« Experimentations (advanced)</a><a class="docs-footer-nextpage" href="get_parameters_and_initial_conditions.html">Calibration »</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="Sunday 9 February 2025 12:30">Sunday 9 February 2025</span>. Using Julia version 1.10.8.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>