Skip to content

Commit 0471b71

Browse files
author
Documenter.jl
committed
build based on 3a4e89b
1 parent 599acdd commit 0471b71

27 files changed

+1999
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"documenter":{"julia_version":"1.11.6","generation_timestamp":"2025-07-13T12:44:09","documenter_version":"1.14.1"}}
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Introduction · ExaModelsPower.jl</title><meta name="title" content="Introduction · ExaModelsPower.jl"/><meta property="og:title" content="Introduction · ExaModelsPower.jl"/><meta property="twitter:title" content="Introduction · 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><a class="tocitem" href="../core/">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>Introduction</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Introduction</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"><h1 id="Introduction"><a class="docs-heading-anchor" href="#Introduction">Introduction</a><a id="Introduction-1"></a><a class="docs-heading-anchor-permalink" href="#Introduction" title="Permalink"></a></h1><p>Welcome to the documentation of <a href="https://github.com/exanauts/ExaModelsPower.jl">ExaModelsPower.jl</a> </p><div class="admonition is-info" id="Note-854f2c4c5726dd3d"><header class="admonition-header">Note<a class="admonition-anchor" href="#Note-854f2c4c5726dd3d" title="Permalink"></a></header><div class="admonition-body"><p>ExaModelsPower runs on julia <code>VERSION ≥ v&quot;1.9&quot;</code></p></div></div><div class="admonition is-warning" id="Warning-8ac7d74cfb458e8c"><header class="admonition-header">Warning<a class="admonition-anchor" href="#Warning-8ac7d74cfb458e8c" title="Permalink"></a></header><div class="admonition-body"><p><strong>Please help us improve ExaModelsPower and this documentation!</strong> ExaModelsPower is in the early stage of development, and you may encounter unintended behaviors or missing documentations. If you find anything is not working as intended or documentation is missing, please <a href="https://github.com/exanauts/ExaModelsPower.jl/issues">open issues</a> or <a href="https://github.com/exanauts/ExaModelsPower.jl/pulls">pull requests</a> or start <a href="https://github.com/exanauts/ExaModelsPower.jl/discussions">discussions</a>. </p></div></div><h2 id="What-is-ExaModelsPower.jl?"><a class="docs-heading-anchor" href="#What-is-ExaModelsPower.jl?">What is ExaModelsPower.jl?</a><a id="What-is-ExaModelsPower.jl?-1"></a><a class="docs-heading-anchor-permalink" href="#What-is-ExaModelsPower.jl?" title="Permalink"></a></h2><p>ExaModelsPower.jl is a Julia package for creating optimal power flow (OPF) models. Unlike other OPF modeling frameworks, ExaModelsPower.jl leverages the capabilities of <a href="https://exanauts.github.io/ExaModels.jl/stable/">ExaModels.jl</a> in order to solve more complex, large-scale versions of the OPF. ExaModels.jl employs what we call <a href="https://en.wikipedia.org/wiki/Single_instruction,_multiple_data">SIMD</a> abstraction for <a href="https://en.wikipedia.org/wiki/Nonlinear_programming">nonlinear programs</a> (NLPs), which allows for the preservation of the parallelizable structure within the model equations, facilitating efficient <a href="https://en.wikipedia.org/wiki/Automatic_differentiation">automatic differentiation</a> either on the single-thread CPUs, multi-threaded CPUs, as well as <a href="https://en.wikipedia.org/wiki/Graphics_processing_unit">GPU accelerators</a>. More details about SIMD abstraction can be found <a href="https://exanauts.github.io/ExaModels.jl/v0.8/simd/">here</a>. ExaModels.jl compiles (via Julia&#39;s compiler) derivative evaluation codes tailored to each computation pattern. Through reverse-mode automatic differentiation using these tailored codes, ExaModels.jl achieves significantly faster derivative evaluation speeds, even when using CPU.</p><p>Recent benchmark results demonstrate that derivative evaluation using ExaModels.jl on GPU can be up to two orders of magnitude faster compared to JuMP or AMPL [<a href="../ref/#shin2024scalablemultiperiodacoptimal">1</a>]. This enables us to implement more complex versions of the OPF without needing any relaxations. Currently, ExaModelsPower.jl supports developing models for static OPF, multi-period OPF with or without storage, and security constrained OPF. ExaModelsPower.jl also supports a number of flexible options for the user to specify model coordinate system, setup of time-varying demand profiles, and handling of complementarity constraints for storage models. </p><h2 id="Supported-Solvers"><a class="docs-heading-anchor" href="#Supported-Solvers">Supported Solvers</a><a id="Supported-Solvers-1"></a><a class="docs-heading-anchor-permalink" href="#Supported-Solvers" title="Permalink"></a></h2><p>ExaModelsPower can be used with any solver that can handle <code>NLPModel</code> data type, but several callbacks are not currently implemented, and cause some errors. Currently, it is tested with the following solvers:</p><ul><li><a href="https://github.com/JuliaSmoothOptimizers/NLPModelsIpopt.jl">Ipopt</a> (via <a href="https://github.com/JuliaSmoothOptimizers/NLPModelsIpopt.jl">NLPModelsIpopt.jl</a>)</li><li><a href="https://github.com/MadNLP/MadNLP.jl">MadNLP.jl</a></li></ul><h2 id="Documentation-Structure"><a class="docs-heading-anchor" href="#Documentation-Structure">Documentation Structure</a><a id="Documentation-Structure-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation-Structure" title="Permalink"></a></h2><p>This documentation is structured in the following way.</p><ul><li>This page provides some introductory information about ExaModelsPower.jl</li><li>The step-by-step tutorials of using ExaModelsPower.jl can be found in <a href="../opf_demo/#opf_demo">OPF tutorial</a> and <a href="../mpopf_demo/#mpopf_demo">MPOPF tutorial</a>.</li><li>The API Manual provides information on functions provided within ExaModelsPower.jl, as well as information on the constraints and variables implemented in the static and multi-period OPFs</li></ul><h2 id="Supporting-ExaModelsPower.jl"><a class="docs-heading-anchor" href="#Supporting-ExaModelsPower.jl">Supporting ExaModelsPower.jl</a><a id="Supporting-ExaModelsPower.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Supporting-ExaModelsPower.jl" title="Permalink"></a></h2><ul><li>Please report issues and feature requests via the <a href="https://github.com/exanauts/ExaModelsPower.jl/issues">GitHub issue tracker</a>.</li><li>Questions are welcome at <a href="https://github.com/exanauts/ExaModelsPower.jl/discussions">GitHub discussion forum</a>.</li></ul></article><nav class="docs-footer"><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 12:44">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)