Skip to content

Commit 599acdd

Browse files
author
Documenter.jl
committed
build based on 8d65100
1 parent 02ac285 commit 599acdd

File tree

10 files changed

+29
-29
lines changed

10 files changed

+29
-29
lines changed

dev/.documenter-siteinfo.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-06-27T16:15:18","documenter_version":"1.13.0"}}
1+
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-07-13T14:43:47","documenter_version":"1.14.1"}}

dev/Introduction/index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

dev/assets/documenter.js

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dev/core/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>API Manual · ExaModelsPower.jl</title><meta name="title" content="API Manual · ExaModelsPower.jl"/><meta property="og:title" content="API Manual · ExaModelsPower.jl"/><meta property="twitter:title" content="API Manual · ExaModelsPower.jl"/><meta name="description" content="Documentation for ExaModelsPower.jl."/><meta property="og:description" content="Documentation for ExaModelsPower.jl."/><meta property="twitter:description" content="Documentation for ExaModelsPower.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><link href="../assets/citations.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="../">ExaModelsPower.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="../">Introduction</a></li><li><input class="collapse-toggle" id="menuitem-2" type="checkbox"/><label class="tocitem" for="menuitem-2"><span class="docs-label">Tutorial</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../opf_demo/">Static OPF</a></li><li><a class="tocitem" href="../mpopf_demo/">Multi-period OPF</a></li></ul></li><li><a class="tocitem" href="../opfs_doc/">OPF Formulations</a></li><li class="is-active"><a class="tocitem" href>API Manual</a></li><li><a class="tocitem" href="../ref/">References</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>API Manual</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API Manual</a></li></ul></nav><div class="docs-right"><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"><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ExaModelsPower.mpopf_model-Tuple{Any, Any}" href="#ExaModelsPower.mpopf_model-Tuple{Any, Any}"><code>ExaModelsPower.mpopf_model</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">mpopf_model(filename, curve; kwargs...)
33
mpopf_model(filename, active_power_data, reactive_power_data; kwargs...)
44
mpopf_model(filename, curve, discharge_func::Function; kwargs...)
5-
mpopf_model(filename, active_power_data, reactive_power_data, discharge_func::Function; kwargs...)</code></pre><p>Construct a multi-period AC optimal power flow (MPOPF) model using different formats of load input data.</p><p><strong>Arguments</strong></p><ul><li><code>filename::String</code>: Path to the network data file (e.g., MATPOWER).</li><li><code>curve::AbstractVector</code>: A time series of demand multiplier values.</li><li><code>active_power_data::String</code>: Path to a matrix of active power loads (Pd) per bus and time.</li><li><code>reactive_power_data::String</code>: Path to a matrix of reactive power loads (Qd).</li><li><code>discharge_func::Function</code>: (Optional) A function specifying battery discharge losses.</li></ul><p><strong>Keyword Arguments</strong></p><ul><li><code>N::Int</code>: Number of time periods (inferred if not provided).</li><li><code>corrective_action_ratio::Float64</code>: Ratio of corrective power action allowed (default = 0.1).</li><li><code>backend</code>: Optimization solver backend (deault = nothing).</li><li><code>form::Symbol</code>: Power flow formulation, either <code>:polar</code> or <code>:rect</code> (default = <code>:polar</code>).</li><li><code>T::Type</code>: Floating-point type for numeric variables (default = <code>Float64</code>).</li><li><code>storage_complementarity_constraint::Bool</code>: Whether to enforce complementarity for storage (only for some methods, default = false).</li><li><code>kwargs...</code>: Additional arguments passed to the solver or builder.</li></ul><p><strong>Returns</strong></p><p>A vector <code>(model::ExaModel object, variables::NamedTuple of variables, constraints::NamedTuple of constraints)</code> representing the MPOPF model.</p><p><strong>Method Variants</strong></p><p>This function is overloaded for different combinations of input:</p><ol><li><code>mpopf_model(filename, curve)</code></li><li><code>mpopf_model(filename, active_power_data, reactive_power_data)</code></li><li><code>mpopf_model(filename, curve, discharge_func)</code></li><li><code>mpopf_model(filename, active_power_data, reactive_power_data, discharge_func)</code></li></ol></div></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ExaModelsPower.opf_model-Tuple{Any}" href="#ExaModelsPower.opf_model-Tuple{Any}"><code>ExaModelsPower.opf_model</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">opf_model(filename; backend, T, form)</code></pre><p>Return <code>ExaModel</code>, variables, and constraints for a static AC Optimal Power Flow (ACOPF) problem from the given file.</p><p><strong>Arguments</strong></p><ul><li><code>filename::String</code>: Path to the data file.</li><li><code>backend</code>: The solver backend to use. Default if nothing.</li><li><code>T</code>: The numeric type to use (default is <code>Float64</code>).</li><li><code>form</code>: Voltage representation, either <code>:polar</code> or <code>:rect</code>. Default is <code>:polar</code>.</li><li><code>kwargs...</code>: Additional keyword arguments passed to the model builder.</li></ul><p><strong>Returns</strong></p><p>A vector <code>(model, variables, constraints)</code>:</p><ul><li><code>model</code>: An <code>ExaModel</code> object.</li><li><code>variables</code>: NamedTuple of model variables.</li><li><code>constraints</code>: NamedTuple of model constraints.</li></ul></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../opfs_doc/">« OPF Formulations</a><a class="docs-footer-nextpage" href="../ref/">References »</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.13.0 on <span class="colophon-date" title="Friday 27 June 2025 16:15">Friday 27 June 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
5+
mpopf_model(filename, active_power_data, reactive_power_data, discharge_func::Function; kwargs...)</code></pre><p>Construct a multi-period AC optimal power flow (MPOPF) model using different formats of load input data.</p><p><strong>Arguments</strong></p><ul><li><code>filename::String</code>: Path to the network data file (e.g., MATPOWER).</li><li><code>curve::AbstractVector</code>: A time series of demand multiplier values.</li><li><code>active_power_data::String</code>: Path to a matrix of active power loads (Pd) per bus and time.</li><li><code>reactive_power_data::String</code>: Path to a matrix of reactive power loads (Qd).</li><li><code>discharge_func::Function</code>: (Optional) A function specifying battery discharge losses.</li></ul><p><strong>Keyword Arguments</strong></p><ul><li><code>N::Int</code>: Number of time periods (inferred if not provided).</li><li><code>corrective_action_ratio::Float64</code>: Ratio of corrective power action allowed (default = 0.1).</li><li><code>backend</code>: Optimization solver backend (deault = nothing).</li><li><code>form::Symbol</code>: Power flow formulation, either <code>:polar</code> or <code>:rect</code> (default = <code>:polar</code>).</li><li><code>T::Type</code>: Floating-point type for numeric variables (default = <code>Float64</code>).</li><li><code>storage_complementarity_constraint::Bool</code>: Whether to enforce complementarity for storage (only for some methods, default = false).</li><li><code>kwargs...</code>: Additional arguments passed to the solver or builder.</li></ul><p><strong>Returns</strong></p><p>A vector <code>(model::ExaModel object, variables::NamedTuple of variables, constraints::NamedTuple of constraints)</code> representing the MPOPF model.</p><p><strong>Method Variants</strong></p><p>This function is overloaded for different combinations of input:</p><ol><li><code>mpopf_model(filename, curve)</code></li><li><code>mpopf_model(filename, active_power_data, reactive_power_data)</code></li><li><code>mpopf_model(filename, curve, discharge_func)</code></li><li><code>mpopf_model(filename, active_power_data, reactive_power_data, discharge_func)</code></li></ol></div></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="ExaModelsPower.opf_model-Tuple{Any}" href="#ExaModelsPower.opf_model-Tuple{Any}"><code>ExaModelsPower.opf_model</code></a><span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">opf_model(filename; backend, T, form)</code></pre><p>Return <code>ExaModel</code>, variables, and constraints for a static AC Optimal Power Flow (ACOPF) problem from the given file.</p><p><strong>Arguments</strong></p><ul><li><code>filename::String</code>: Path to the data file.</li><li><code>backend</code>: The solver backend to use. Default if nothing.</li><li><code>T</code>: The numeric type to use (default is <code>Float64</code>).</li><li><code>form</code>: Voltage representation, either <code>:polar</code> or <code>:rect</code>. Default is <code>:polar</code>.</li><li><code>kwargs...</code>: Additional keyword arguments passed to the model builder.</li></ul><p><strong>Returns</strong></p><p>A vector <code>(model, variables, constraints)</code>:</p><ul><li><code>model</code>: An <code>ExaModel</code> object.</li><li><code>variables</code>: NamedTuple of model variables.</li><li><code>constraints</code>: NamedTuple of model constraints.</li></ul></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../opfs_doc/">« OPF Formulations</a><a class="docs-footer-nextpage" href="../ref/">References »</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.14.1 on <span class="colophon-date" title="Sunday 13 July 2025 14:43">Sunday 13 July 2025</span>. Using Julia version 1.11.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)