build based on e81bbbd

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.8.5","generation_timestamp":"2023-11-26T01:35:08","documenter_version":"1.1.2"}}
+{"documenter":{"julia_version":"1.8.5","generation_timestamp":"2023-12-03T01:34:28","documenter_version":"1.2.1"}}

dev/index.html

@@ -5,4 +5,4 @@
   author={Pacaud, Fran{\c{c}}ois and Shin, Sungho and Schanen, Michel and Maldonado, Daniel Adrian and Anitescu, Mihai},
   journal={arXiv preprint arXiv:2203.11875},
   year={2022}
-}</code></pre><h2 id="Funding"><a class="docs-heading-anchor" href="#Funding">Funding</a><a id="Funding-1"></a><a class="docs-heading-anchor-permalink" href="#Funding" title="Permalink"></a></h2><p>This research was supported by the Exascale Computing Project (17-SC-20-SC), a joint project of the U.S. Department of Energy’s Office of Science and National Nuclear Security Administration, responsible for delivering a capable exascale ecosystem, including software, applications, and hardware technology, to support the nation’s exascale computing imperative.</p><h2 id="Table-of-contents"><a class="docs-heading-anchor" href="#Table-of-contents">Table of contents</a><a id="Table-of-contents-1"></a><a class="docs-heading-anchor-permalink" href="#Table-of-contents" title="Permalink"></a></h2><h3 id="Quickstart-2"><a class="docs-heading-anchor" href="#Quickstart-2">Quickstart</a><a class="docs-heading-anchor-permalink" href="#Quickstart-2" title="Permalink"></a></h3><ul><li><a href="quickstart/cpu/#Argos-on-CPU-(default)">Argos on CPU (default)</a></li><li><a href="quickstart/cuda/#Argos-on-NVIDIA-GPU">Argos on NVIDIA GPU</a></li></ul><h3 id="OPF-Model"><a class="docs-heading-anchor" href="#OPF-Model">OPF Model</a><a id="OPF-Model-1"></a><a class="docs-heading-anchor-permalink" href="#OPF-Model" title="Permalink"></a></h3><ul><li><a href="man/overview/#Overview">Overview</a></li><li><a href="man/fullspace/#FullSpaceEvaluator">FullSpaceEvaluator</a></li><li><a href="man/reducedspace/#ReducedSpaceEvaluator">ReducedSpaceEvaluator</a></li></ul><h3 id="OPF-Solution"><a class="docs-heading-anchor" href="#OPF-Solution">OPF Solution</a><a id="OPF-Solution-1"></a><a class="docs-heading-anchor-permalink" href="#OPF-Solution" title="Permalink"></a></h3><ul><li><a href="optim/fullspace/#Full-space-OPF">Full-space OPF</a></li><li><a href="optim/reducedspace/#Reduced-space-OPF">Reduced-space OPF</a></li><li><a href="optim/biegler/#Biegler&#39;s-method">Biegler&#39;s method</a></li></ul><h3 id="Wrappers"><a class="docs-heading-anchor" href="#Wrappers">Wrappers</a><a id="Wrappers-1"></a><a class="docs-heading-anchor-permalink" href="#Wrappers" title="Permalink"></a></h3><ul><li><a href="man/moi_wrapper/#MathOptInterface-wrapper">MathOptInterface wrapper</a></li><li><a href="man/nlpmodel_wrapper/#NLPModels">NLPModels</a></li></ul><h3 id="Library"><a class="docs-heading-anchor" href="#Library">Library</a><a id="Library-1"></a><a class="docs-heading-anchor-permalink" href="#Library" title="Permalink"></a></h3><ul><li><a href="lib/api/#Evaluator-API">Evaluator API</a></li><li><a href="lib/evaluators/#Evaluators">Evaluators</a></li><li><a href="lib/kkt/#KKT-systems">KKT systems</a></li><li><a href="lib/wrappers/#Wrappers">Wrappers</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quickstart/cpu/">Argos on CPU (default) »</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="Sunday 26 November 2023 01:35">Sunday 26 November 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+}</code></pre><h2 id="Funding"><a class="docs-heading-anchor" href="#Funding">Funding</a><a id="Funding-1"></a><a class="docs-heading-anchor-permalink" href="#Funding" title="Permalink"></a></h2><p>This research was supported by the Exascale Computing Project (17-SC-20-SC), a joint project of the U.S. Department of Energy’s Office of Science and National Nuclear Security Administration, responsible for delivering a capable exascale ecosystem, including software, applications, and hardware technology, to support the nation’s exascale computing imperative.</p><h2 id="Table-of-contents"><a class="docs-heading-anchor" href="#Table-of-contents">Table of contents</a><a id="Table-of-contents-1"></a><a class="docs-heading-anchor-permalink" href="#Table-of-contents" title="Permalink"></a></h2><h3 id="Quickstart-2"><a class="docs-heading-anchor" href="#Quickstart-2">Quickstart</a><a class="docs-heading-anchor-permalink" href="#Quickstart-2" title="Permalink"></a></h3><ul><li><a href="quickstart/cpu/#Argos-on-CPU-(default)">Argos on CPU (default)</a></li><li><a href="quickstart/cuda/#Argos-on-NVIDIA-GPU">Argos on NVIDIA GPU</a></li></ul><h3 id="OPF-Model"><a class="docs-heading-anchor" href="#OPF-Model">OPF Model</a><a id="OPF-Model-1"></a><a class="docs-heading-anchor-permalink" href="#OPF-Model" title="Permalink"></a></h3><ul><li><a href="man/overview/#Overview">Overview</a></li><li><a href="man/fullspace/#FullSpaceEvaluator">FullSpaceEvaluator</a></li><li><a href="man/reducedspace/#ReducedSpaceEvaluator">ReducedSpaceEvaluator</a></li></ul><h3 id="OPF-Solution"><a class="docs-heading-anchor" href="#OPF-Solution">OPF Solution</a><a id="OPF-Solution-1"></a><a class="docs-heading-anchor-permalink" href="#OPF-Solution" title="Permalink"></a></h3><ul><li><a href="optim/fullspace/#Full-space-OPF">Full-space OPF</a></li><li><a href="optim/reducedspace/#Reduced-space-OPF">Reduced-space OPF</a></li><li><a href="optim/biegler/#Biegler&#39;s-method">Biegler&#39;s method</a></li></ul><h3 id="Wrappers"><a class="docs-heading-anchor" href="#Wrappers">Wrappers</a><a id="Wrappers-1"></a><a class="docs-heading-anchor-permalink" href="#Wrappers" title="Permalink"></a></h3><ul><li><a href="man/moi_wrapper/#MathOptInterface-wrapper">MathOptInterface wrapper</a></li><li><a href="man/nlpmodel_wrapper/#NLPModels">NLPModels</a></li></ul><h3 id="Library"><a class="docs-heading-anchor" href="#Library">Library</a><a id="Library-1"></a><a class="docs-heading-anchor-permalink" href="#Library" title="Permalink"></a></h3><ul><li><a href="lib/api/#Evaluator-API">Evaluator API</a></li><li><a href="lib/evaluators/#Evaluators">Evaluators</a></li><li><a href="lib/kkt/#KKT-systems">KKT systems</a></li><li><a href="lib/wrappers/#Wrappers">Wrappers</a></li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quickstart/cpu/">Argos on CPU (default) »</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="Sunday 3 December 2023 01:34">Sunday 3 December 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/lib/evaluators/index.html

@@ -90,4 +90,4 @@
 julia> @assert isa(x, Array) # x is defined on the host memory
 
 julia> Argos.objective(bdg, x) # evaluate the objective on the device
-</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/e81bbbd3017b6f097aed6765fa525a69784f36e0/src/Evaluators/bridge_evaluator.jl#L14-L40">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« Evaluators API</a><a class="docs-footer-nextpage" href="../kkt/">KKT systems »</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="Sunday 26 November 2023 01:35">Sunday 26 November 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/e81bbbd3017b6f097aed6765fa525a69784f36e0/src/Evaluators/bridge_evaluator.jl#L14-L40">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« Evaluators API</a><a class="docs-footer-nextpage" href="../kkt/">KKT systems »</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="Sunday 3 December 2023 01:34">Sunday 3 December 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/lib/kkt/index.html

@@ -23,4 +23,4 @@
 julia> kkt = Argos.MixedAuglagKKTSystem{T, VT, MT}(opf)
 
 julia> MadNLP.get_kkt(kkt) # return the matrix to factorize
-</code></pre><p><strong>Notes</strong></p><p><code>MixedAuglagKKTSystem</code> can be instantiated both on the host memory (CPU) or on a NVIDIA GPU using CUDA.</p><p>Supports only bound-constrained optimization problem (so no Jacobian).</p><p><strong>References</strong></p><p>[PMSSA2022] Pacaud, François, Daniel Adrian Maldonado, Sungho Shin, Michel Schanen, and Mihai Anitescu. &quot;A feasible reduced space method for real-time optimal power flow.&quot; Electric Power Systems Research 212 (2022): 108268.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/e81bbbd3017b6f097aed6765fa525a69784f36e0/src/KKT/auglag_kkt.jl#L1-L37">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../evaluators/">« Evaluators Type</a><a class="docs-footer-nextpage" href="../wrappers/">Wrappers »</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="Sunday 26 November 2023 01:35">Sunday 26 November 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p><strong>Notes</strong></p><p><code>MixedAuglagKKTSystem</code> can be instantiated both on the host memory (CPU) or on a NVIDIA GPU using CUDA.</p><p>Supports only bound-constrained optimization problem (so no Jacobian).</p><p><strong>References</strong></p><p>[PMSSA2022] Pacaud, François, Daniel Adrian Maldonado, Sungho Shin, Michel Schanen, and Mihai Anitescu. &quot;A feasible reduced space method for real-time optimal power flow.&quot; Electric Power Systems Research 212 (2022): 108268.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/e81bbbd3017b6f097aed6765fa525a69784f36e0/src/KKT/auglag_kkt.jl#L1-L37">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../evaluators/">« Evaluators Type</a><a class="docs-footer-nextpage" href="../wrappers/">Wrappers »</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="Sunday 3 December 2023 01:34">Sunday 3 December 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/lib/wrappers/index.html

@@ -9,4 +9,4 @@
 julia> nlp = Argos.ReducedSpaceEvaluator(datafile);
 
 julia> ev = Argos.MOIEvaluator(nlp)
-</code></pre><p><strong>Attributes</strong></p><ul><li><code>nlp::AbstractNLPEvaluator</code>: the underlying <code>ExaPF</code> problem.</li><li><code>hash_x::UInt</code>: hash of the last evaluated variable <code>x</code></li><li><code>has_hess::Bool</code> (default: <code>false</code>): if <code>true</code>, pass a Hessian structure to MOI.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/e81bbbd3017b6f097aed6765fa525a69784f36e0/src/Wrappers/MOI_wrapper.jl#L3-L25">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../kkt/">« KKT systems</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="Sunday 26 November 2023 01:35">Sunday 26 November 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre><p><strong>Attributes</strong></p><ul><li><code>nlp::AbstractNLPEvaluator</code>: the underlying <code>ExaPF</code> problem.</li><li><code>hash_x::UInt</code>: hash of the last evaluated variable <code>x</code></li><li><code>has_hess::Bool</code> (default: <code>false</code>): if <code>true</code>, pass a Hessian structure to MOI.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/exanauts/Argos.jl/blob/e81bbbd3017b6f097aed6765fa525a69784f36e0/src/Wrappers/MOI_wrapper.jl#L3-L25">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../kkt/">« KKT systems</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="Sunday 3 December 2023 01:34">Sunday 3 December 2023</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>