Skip to content

Commit 14e5347

Browse files
author
Documenter.jl
committed
build based on 8e9eee7 
1 parent 6fc356e commit 14e5347

5 files changed

Lines changed: 5 additions & 24 deletions

File tree

‎dev/api/index.html‎

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,2 @@
11
<!DOCTYPE html>
2-
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · DistributedResourceOptimization.jl Documentation</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../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><link href="../assets/theme_overrides.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">DistributedResourceOptimization.jl Documentation</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../getting_started/">Getting Started</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li class="toplevel"><a class="tocitem" href="#Express"><span>Express</span></a></li><li class="toplevel"><a class="tocitem" href="#Agent-and-Roles"><span>Agent and Roles</span></a></li><li class="toplevel"><a class="tocitem" href="#Real-time-container"><span>Real time container</span></a></li><li class="toplevel"><a class="tocitem" href="#Simulation"><span>Simulation</span></a></li><li class="toplevel"><a class="tocitem" href="#Simulation-Environment"><span>Simulation Environment</span></a></li><li class="toplevel"><a class="tocitem" href="#Scheduling"><span>Scheduling</span></a></li><li class="toplevel"><a class="tocitem" href="#Topology"><span>Topology</span></a></li><li class="toplevel"><a class="tocitem" href="#Encoding/Decoding"><span>Encoding/Decoding</span></a></li><li class="toplevel"><a class="tocitem" href="#Misc"><span>Misc</span></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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/Digitalized-Energy-Systems/DistributedResourceOptimization.jl" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h1 id="Express"><a class="docs-heading-anchor" href="#Express">Express</a><a id="Express-1"></a><a class="docs-heading-anchor-permalink" href="#Express" title="Permalink"></a></h1><p>This part contains basic convenience functions for creating and running Mango.jl simulations. </p><pre><code class="language- hljs">Modules = [Mango]
3-
Private = false
4-
Pages = [&quot;express/api.jl&quot;]</code></pre><h1 id="Agent-and-Roles"><a class="docs-heading-anchor" href="#Agent-and-Roles">Agent and Roles</a><a id="Agent-and-Roles-1"></a><a class="docs-heading-anchor-permalink" href="#Agent-and-Roles" title="Permalink"></a></h1><p>Here, the API for the agent structs created with @agent/@role is listed. </p><pre><code class="language- hljs">Modules = [Mango]
5-
Private = false
6-
Pages = [&quot;agent/api.jl&quot;, &quot;agent/core.jl&quot;, &quot;agent/role.jl&quot;, &quot;agent/services.jl&quot;]
7-
Order = [:macro, :function, :constant, :type, :module]</code></pre><h1 id="Real-time-container"><a class="docs-heading-anchor" href="#Real-time-container">Real time container</a><a id="Real-time-container-1"></a><a class="docs-heading-anchor-permalink" href="#Real-time-container" title="Permalink"></a></h1><p>This part contains the API related to the container construction, access and management.</p><pre><code class="language- hljs">Modules = [Mango]
8-
Private = false
9-
Pages = [&quot;container/api.jl&quot;, &quot;container/core.jl&quot;, &quot;container/mqtt.jl&quot;, &quot;container/protocol.jl&quot;, &quot;container/tcp.jl&quot;]</code></pre><h1 id="Simulation"><a class="docs-heading-anchor" href="#Simulation">Simulation</a><a id="Simulation-1"></a><a class="docs-heading-anchor-permalink" href="#Simulation" title="Permalink"></a></h1><p>In the following the APIs regarding the simulation world are listed.</p><pre><code class="language- hljs">Modules = [Mango]
10-
Private = false
11-
Pages = [&quot;simulation/container.jl&quot;, &quot;simulation/communication.jl&quot;, &quot;simulation/tasks.jl&quot;, &quot;simulation/world.jl&quot;]</code></pre><h1 id="Simulation-Environment"><a class="docs-heading-anchor" href="#Simulation-Environment">Simulation Environment</a><a id="Simulation-Environment-1"></a><a class="docs-heading-anchor-permalink" href="#Simulation-Environment" title="Permalink"></a></h1><p>In the following the APIs regarding the simulation environment are listed.</p><pre><code class="language- hljs">Modules = [Mango]
12-
Private = false
13-
Pages = [&quot;environment/api.jl&quot;, &quot;environment/core.jl&quot;]</code></pre><h1 id="Scheduling"><a class="docs-heading-anchor" href="#Scheduling">Scheduling</a><a id="Scheduling-1"></a><a class="docs-heading-anchor-permalink" href="#Scheduling" title="Permalink"></a></h1><p>In the following the APIs for scheduling TaskData is listed.</p><pre><code class="language- hljs">Modules = [Mango]
14-
Private = false
15-
Pages = [&quot;util/scheduling.jl&quot;]</code></pre><h1 id="Topology"><a class="docs-heading-anchor" href="#Topology">Topology</a><a id="Topology-1"></a><a class="docs-heading-anchor-permalink" href="#Topology" title="Permalink"></a></h1><p>In the following the APIs for creating, aplying and using topologies is listed.</p><pre><code class="language- hljs">Modules = [Mango]
16-
Private = false
17-
Pages = [&quot;util/topology.jl&quot;]</code></pre><h1 id="Encoding/Decoding"><a class="docs-heading-anchor" href="#Encoding/Decoding">Encoding/Decoding</a><a id="Encoding/Decoding-1"></a><a class="docs-heading-anchor-permalink" href="#Encoding/Decoding" title="Permalink"></a></h1><p>In the following the built-in functions for encoding and decoding messages are listed.</p><pre><code class="language- hljs">Modules = [Mango]
18-
Private = false
19-
Pages = [&quot;util/encode_decode.jl&quot;]</code></pre><h1 id="Misc"><a class="docs-heading-anchor" href="#Misc">Misc</a><a id="Misc-1"></a><a class="docs-heading-anchor-permalink" href="#Misc" title="Permalink"></a></h1><pre><code class="language- hljs">Modules = [Mango]
20-
Private = false
21-
Pages = [&quot;util/datastructures_util.jl&quot;]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../getting_started/">« Getting Started</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 14 October 2025 15:45">Tuesday 14 October 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API · DistributedResourceOptimization.jl Documentation</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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="../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><link href="../assets/theme_overrides.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">DistributedResourceOptimization.jl Documentation</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../getting_started/">Getting Started</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li class="toplevel"><a class="tocitem" href="#Algorithm-Core-Functions"><span>Algorithm Core Functions</span></a></li><li class="toplevel"><a class="tocitem" href="#Carrier-Core"><span>Carrier Core</span></a></li><li class="toplevel"><a class="tocitem" href="#Mango-Carrier"><span>Mango Carrier</span></a></li><li class="toplevel"><a class="tocitem" href="#ADMM-Sharing"><span>ADMM Sharing</span></a></li><li class="toplevel"><a class="tocitem" href="#ADMM-Consensus"><span>ADMM Consensus</span></a></li><li class="toplevel"><a class="tocitem" href="#ADMM-Flex"><span>ADMM Flex</span></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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/Digitalized-Energy-Systems/DistributedResourceOptimization.jl" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h1><h1 id="Algorithm-Core-Functions"><a class="docs-heading-anchor" href="#Algorithm-Core-Functions">Algorithm Core Functions</a><a id="Algorithm-Core-Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Algorithm-Core-Functions" title="Permalink"></a></h1><h1 id="Carrier-Core"><a class="docs-heading-anchor" href="#Carrier-Core">Carrier Core</a><a id="Carrier-Core-1"></a><a class="docs-heading-anchor-permalink" href="#Carrier-Core" title="Permalink"></a></h1><h1 id="Mango-Carrier"><a class="docs-heading-anchor" href="#Mango-Carrier">Mango Carrier</a><a id="Mango-Carrier-1"></a><a class="docs-heading-anchor-permalink" href="#Mango-Carrier" title="Permalink"></a></h1><h1 id="ADMM-Sharing"><a class="docs-heading-anchor" href="#ADMM-Sharing">ADMM Sharing</a><a id="ADMM-Sharing-1"></a><a class="docs-heading-anchor-permalink" href="#ADMM-Sharing" title="Permalink"></a></h1><h1 id="ADMM-Consensus"><a class="docs-heading-anchor" href="#ADMM-Consensus">ADMM Consensus</a><a id="ADMM-Consensus-1"></a><a class="docs-heading-anchor-permalink" href="#ADMM-Consensus" title="Permalink"></a></h1><h1 id="ADMM-Flex"><a class="docs-heading-anchor" href="#ADMM-Flex">ADMM Flex</a><a id="ADMM-Flex-1"></a><a class="docs-heading-anchor-permalink" href="#ADMM-Flex" title="Permalink"></a></h1></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../getting_started/">« Getting Started</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 14 October 2025 15:53">Tuesday 14 October 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

‎dev/getting_started/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@
6363
# run simulation
6464
activate(container) do
6565
send_message(agent_one, initial_message, address(agent_two))
66-
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../api/">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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 14 October 2025 15:45">Tuesday 14 October 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
66+
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><a class="docs-footer-nextpage" href="../api/">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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 14 October 2025 15:53">Tuesday 14 October 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)