build based on 4cafa46

AlgebraicJulia · Jan 12, 2024 · 5ded4a3 · 5ded4a3
1 parent 9c6a8e6
commit 5ded4a3
Show file tree

Hide file tree

Showing 34 changed files with 107 additions and 102 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-11-09T14:41:10","documenter_version":"1.1.2"}}
+{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-12T18:16:43","documenter_version":"1.2.1"}}
diff --git a/dev/api/index.html b/dev/api/index.html
diff --git a/dev/ascii/index.html b/dev/ascii/index.html
diff --git a/dev/assets/themes/documenter-dark.css b/dev/assets/themes/documenter-dark.css
diff --git a/dev/assets/themes/documenter-light.css b/dev/assets/themes/documenter-light.css
diff --git a/dev/bc_debug/index.html b/dev/bc_debug/index.html
@@ -1,6 +1,8 @@
 <!DOCTYPE html>
 <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Misc Features · Decapodes.jl</title><meta name="title" content="Misc Features · Decapodes.jl"/><meta property="og:title" content="Misc Features · Decapodes.jl"/><meta property="twitter:title" content="Misc Features · Decapodes.jl"/><meta name="description" content="Documentation for Decapodes.jl."/><meta property="og:description" content="Documentation for Decapodes.jl."/><meta property="twitter:description" content="Documentation for Decapodes.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/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><script src="../assets/analytics.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Decapodes.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="../">Decapodes.jl</a></li><li><a class="tocitem" href="../overview/">Overview</a></li><li><a class="tocitem" href="../equations/">Equations</a></li><li><a class="tocitem" href="../ascii/">ASCII Operators</a></li><li class="is-active"><a class="tocitem" href>Misc Features</a></li><li><a class="tocitem" href="../poiseuille/">Pipe Flow</a></li><li><a class="tocitem" href="../ice_dynamics/">Glacial Flow</a></li><li><a class="tocitem" href="../grigoriev/">Grigoriev Ice Cap</a></li><li><a class="tocitem" href="../budyko_sellers_halfar/">Budyko-Sellers-Halfar</a></li><li><a class="tocitem" href="../api/">Library 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>Misc Features</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Misc Features</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/AlgebraicJulia/Decapodes.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/AlgebraicJulia/Decapodes.jl/blob/main/docs/src/bc_debug.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="Simulation-Setup"><a class="docs-heading-anchor" href="#Simulation-Setup">Simulation Setup</a><a id="Simulation-Setup-1"></a><a class="docs-heading-anchor-permalink" href="#Simulation-Setup" title="Permalink"></a></h1><p>This tutorial showcases some of the other features included in the Decapodes.jl package. Currently, these features are the treatment of boundary conditions and the simulation debugger interface. To begin, we set up the same advection-diffusion problem presented in the Overview section. As before, we define the Diffusion, Advection, and Superposition components, and now include a BC (Bounday Condition) component. Decapodes.jl interprets any <code>Hom</code> which begins with a <code>∂</code> as a boundary condition. These boundary conditions recieve special treatment at the scheduling step. Below we show the graphical rendering of this boundary condition diagram, which we will use to impose a Dirichlet condition on the time derivative of concentration at the mesh boundary.</p><pre><code class="language-julia hljs">using Catlab
 using Catlab.Graphics
+using DiagrammaticEquations
+using DiagrammaticEquations.Deca
 using Decapodes
 
 Diffusion = @decapode begin
@@ -340,4 +342,4 @@
 # Animation
 record(fig, &quot;diff_adv_right.gif&quot;, range(0.0, 100.0; length=150); framerate = 30) do t
   ob.color = sol(t).C
-end</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">&quot;diff_adv_right.gif&quot;</code></pre><p><img src="../diff_adv_right.gif" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../ascii/">« ASCII Operators</a><a class="docs-footer-nextpage" href="../poiseuille/">Pipe Flow »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Thursday 9 November 2023 14:41">Thursday 9 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">&quot;diff_adv_right.gif&quot;</code></pre><p><img src="../diff_adv_right.gif" alt/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../ascii/">« ASCII Operators</a><a class="docs-footer-nextpage" href="../poiseuille/">Pipe Flow »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 12 January 2024 18:16">Friday 12 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/budyko_sellers.jld2 b/dev/budyko_sellers.jld2
diff --git a/dev/budyko_sellers_halfar.jld2 b/dev/budyko_sellers_halfar.jld2
diff --git a/dev/budyko_sellers_halfar/466a8d9c.png b/dev/budyko_sellers_halfar/466a8d9c.png
diff --git a/dev/budyko_sellers_halfar/d704e1aa.png b/dev/budyko_sellers_halfar/d704e1aa.png
diff --git a/dev/budyko_sellers_halfar/index.html b/dev/budyko_sellers_halfar/index.html
@@ -3,6 +3,8 @@
 using Catlab
 using Catlab.Graphics
 using CombinatorialSpaces
+using DiagrammaticEquations
+using DiagrammaticEquations.Deca
 using Decapodes
 
 # External Dependencies
@@ -221,7 +223,7 @@
 @info(&quot;Done&quot;)</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">[ Info: Precompiling Solver
 [ Info: Solving
 soln.retcode = SciMLBase.ReturnCode.Success
-[ Info: Done</code></pre><p>We can save the solution file to examine later.</p><pre><code class="language-julia hljs">@save &quot;budyko_sellers_halfar.jld2&quot; soln</code></pre><h2 id="Visualize"><a class="docs-heading-anchor" href="#Visualize">Visualize</a><a id="Visualize-1"></a><a class="docs-heading-anchor-permalink" href="#Visualize" title="Permalink"></a></h2><p>Quickly examine the final conditions for temperature.</p><pre><code class="language-julia hljs">lines(map(x -&gt; x[1], point(s′)), soln(tₑ).Tₛ)</code></pre><img src="e5e14bac.png" alt="Example block output"/><p>Quickly examine the final conditions for ice height.</p><pre><code class="language-julia hljs">lines(map(x -&gt; x[1], point(s′)), soln(tₑ).halfar_h)</code></pre><img src="d704e1aa.png" alt="Example block output"/><p>Create animated GIFs of the temperature and ice height dynamics.</p><pre><code class="language-julia hljs">begin
+[ Info: Done</code></pre><p>We can save the solution file to examine later.</p><pre><code class="language-julia hljs">@save &quot;budyko_sellers_halfar.jld2&quot; soln</code></pre><h2 id="Visualize"><a class="docs-heading-anchor" href="#Visualize">Visualize</a><a id="Visualize-1"></a><a class="docs-heading-anchor-permalink" href="#Visualize" title="Permalink"></a></h2><p>Quickly examine the final conditions for temperature.</p><pre><code class="language-julia hljs">lines(map(x -&gt; x[1], point(s′)), soln(tₑ).Tₛ)</code></pre><img src="e5e14bac.png" alt="Example block output"/><p>Quickly examine the final conditions for ice height.</p><pre><code class="language-julia hljs">lines(map(x -&gt; x[1], point(s′)), soln(tₑ).halfar_h)</code></pre><img src="466a8d9c.png" alt="Example block output"/><p>Create animated GIFs of the temperature and ice height dynamics.</p><pre><code class="language-julia hljs">begin
 # Initial frame
 frames = 100
 fig = Figure(resolution = (800, 800))
@@ -251,4 +253,4 @@
 record(fig, &quot;budyko_sellers_halfar_h.gif&quot;, range(0.0, tₑ; length=frames); framerate = 15) do t
   lines!(fig[1,1], map(x -&gt; x[1], point(s′)), soln(t).halfar_h)
 end
-end</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">&quot;budyko_sellers_halfar_h.gif&quot;</code></pre><p><img src="../budyko_sellers_halfar_T.gif" alt="BSH_Temperature"/></p><p><img src="../budyko_sellers_halfar_h.gif" alt="BSH_IceHeight"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../grigoriev/">« Grigoriev Ice Cap</a><a class="docs-footer-nextpage" href="../api/">Library 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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Thursday 9 November 2023 14:41">Thursday 9 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+end</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">&quot;budyko_sellers_halfar_h.gif&quot;</code></pre><p><img src="../budyko_sellers_halfar_T.gif" alt="BSH_Temperature"/></p><p><img src="../budyko_sellers_halfar_h.gif" alt="BSH_IceHeight"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../grigoriev/">« Grigoriev Ice Cap</a><a class="docs-footer-nextpage" href="../api/">Library 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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 12 January 2024 18:16">Friday 12 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/budyko_sellers_halfar_h.gif b/dev/budyko_sellers_halfar_h.gif
diff --git a/dev/equations/index.html b/dev/equations/index.html
@@ -3,14 +3,16 @@
 using Catlab.Graphics
 using CombinatorialSpaces
 using CombinatorialSpaces.ExteriorCalculus
+using DiagrammaticEquations
+using DiagrammaticEquations.Deca
 using Decapodes</code></pre><p>The harmonic oscillator can be written in Decapodes in at least three different ways.</p><pre><code class="language-julia hljs">oscillator = @decapode begin
   X::Form0
   V::Form0
 
   ∂ₜ(X) == V
   ∂ₜ(V) == -k(X)
 end</code></pre><div class="c-set">
-<span class="c-set-summary">SummationDecapode{Any, Any, Symbol} {Var:4, TVar:2, Op1:4, Op2:0, Σ:0, Summand:0, Type:0, Operator:0, Name:0}</span>
+<span class="c-set-summary">DiagrammaticEquations.SummationDecapode{Any, Any, Symbol} {Var:4, TVar:2, Op1:4, Op2:0, Σ:0, Summand:0, Type:0, Operator:0, Name:0}</span>
 <table>
   <thead>
     <tr class = "header headerLastRow">
@@ -197,7 +199,7 @@
   ∂ₜ(X) == V
   ∂ₜ(V) == -k*(X)
 end</code></pre><div class="c-set">
-<span class="c-set-summary">SummationDecapode{Any, Any, Symbol} {Var:5, TVar:2, Op1:3, Op2:1, Σ:0, Summand:0, Type:0, Operator:0, Name:0}</span>
+<span class="c-set-summary">DiagrammaticEquations.SummationDecapode{Any, Any, Symbol} {Var:5, TVar:2, Op1:3, Op2:1, Σ:0, Summand:0, Type:0, Operator:0, Name:0}</span>
 <table>
   <thead>
     <tr class = "header headerLastRow">
@@ -435,7 +437,7 @@
   ∂ₜ(X) == V
   ∂ₜ(V) == -1*k*(X)
 end</code></pre><div class="c-set">
-<span class="c-set-summary">SummationDecapode{Any, Any, Symbol} {Var:6, TVar:2, Op1:2, Op2:2, Σ:0, Summand:0, Type:0, Operator:0, Name:0}</span>
+<span class="c-set-summary">DiagrammaticEquations.SummationDecapode{Any, Any, Symbol} {Var:6, TVar:2, Op1:2, Op2:2, Σ:0, Summand:0, Type:0, Operator:0, Name:0}</span>
 <table>
   <thead>
     <tr class = "header headerLastRow">
@@ -706,7 +708,7 @@
   ∂ₜ(X) == V
   ∂ₜ(V) == -1*k*(X)
 end</code></pre><div class="c-set">
-<span class="c-set-summary">SummationDecapode{Any, Any, Symbol} {Var:6, TVar:2, Op1:2, Op2:2, Σ:0, Summand:0, Type:0, Operator:0, Name:0}</span>
+<span class="c-set-summary">DiagrammaticEquations.SummationDecapode{Any, Any, Symbol} {Var:6, TVar:2, Op1:2, Op2:2, Σ:0, Summand:0, Type:0, Operator:0, Name:0}</span>
 <table>
   <thead>
     <tr class = "header headerLastRow">
@@ -968,4 +970,4 @@
 </g>
 </g>
 </svg>
-'/><p>Often you will have a linear material where you are scaling by a constant, and a nonlinear version of that material where that scaling is replaced by a generic nonlinear function. This is why we allow Decapodes to represent both of these types of equations.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview/">« Overview</a><a class="docs-footer-nextpage" href="../ascii/">ASCII Operators »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Thursday 9 November 2023 14:41">Thursday 9 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+'/><p>Often you will have a linear material where you are scaling by a constant, and a nonlinear version of that material where that scaling is replaced by a generic nonlinear function. This is why we allow Decapodes to represent both of these types of equations.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../overview/">« Overview</a><a class="docs-footer-nextpage" href="../ascii/">ASCII Operators »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.2.1 on <span class="colophon-date" title="Friday 12 January 2024 18:16">Friday 12 January 2024</span>. Using Julia version 1.10.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/grigoriev.jld2 b/dev/grigoriev.jld2
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.9.3","generation_timestamp":"2023-11-09T14:41:10","documenter_version":"1.1.2"}}
		{"documenter":{"julia_version":"1.10.0","generation_timestamp":"2024-01-12T18:16:43","documenter_version":"1.2.1"}}