From 05eb798a6ae3442ab43fb3db58dc17fcd990752b Mon Sep 17 00:00:00 2001 From: Sophie Frasnedo Date: Wed, 27 Nov 2024 23:18:53 +0100 Subject: [PATCH] First addition of readthedocs Signed-off-by: Sophie Frasnedo --- .gitignore | 3 + docs/.readthedocs.yaml | 13 ++ docs/Makefile | 27 +++ docs/README.md | 63 +++++++ docs/_static/favicon.ico | Bin 0 -> 2017 bytes docs/_static/logos/logo_lfe_powsybl.svg | 76 ++++++++ docs/_static/styles/styles.css | 6 + docs/_templates/page.html | 101 +++++++++++ docs/_templates/sidebar/brand.html | 25 +++ docs/conf.py | 168 ++++++++++++++++++ docs/gettingStarted.md | 23 +++ docs/index.md | 19 ++ docs/make.bat | 35 ++++ .../_static/img/reactive-diagram.png | Bin 0 -> 14258 bytes docs/optimizer/acOptimalPowerflow.md | 88 +++++++++ docs/optimizer/dcOptimalPowerflow.md | 29 +++ docs/optimizer/divisionOfCode.md | 23 +++ docs/optimizer/index.md | 26 +++ docs/optimizer/inputs.md | 61 +++++++ docs/optimizer/outputs.md | 35 ++++ docs/optimizer/preprocessing.md | 56 ++++++ docs/optimizer/slackBusMainConnexComponent.md | 23 +++ docs/requirements.txt | 5 + 23 files changed, 905 insertions(+) create mode 100644 docs/.readthedocs.yaml create mode 100644 docs/Makefile create mode 100644 docs/README.md create mode 100644 docs/_static/favicon.ico create mode 100644 docs/_static/logos/logo_lfe_powsybl.svg create mode 100644 docs/_static/styles/styles.css create mode 100644 docs/_templates/page.html create mode 100644 docs/_templates/sidebar/brand.html create mode 100644 docs/conf.py create mode 100644 docs/gettingStarted.md create mode 100644 docs/index.md create mode 100644 docs/make.bat create mode 100644 docs/optimizer/_static/img/reactive-diagram.png create mode 100644 docs/optimizer/acOptimalPowerflow.md create mode 100644 docs/optimizer/dcOptimalPowerflow.md create mode 100644 docs/optimizer/divisionOfCode.md create mode 100644 docs/optimizer/index.md create mode 100644 docs/optimizer/inputs.md create mode 100644 docs/optimizer/outputs.md create mode 100644 docs/optimizer/preprocessing.md create mode 100644 docs/optimizer/slackBusMainConnexComponent.md create mode 100644 docs/requirements.txt diff --git a/.gitignore b/.gitignore index 4c4e2877..b2e60a78 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,6 @@ org.eclipse.jdt.groovy.core.prefs # AMPL computation result files **/AMPL_runner_*.err **/AMPL_runner_*.out + +# Generated readthedocs pages +build-docs/ diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml new file mode 100644 index 00000000..934aaace --- /dev/null +++ b/docs/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: ubuntu-20.04 + tools: + python: "3.9" + +sphinx: + configuration: docs/conf.py + +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..4d15385e --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,27 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + + +clean: + @echo "Removing $(SOURCEDIR)/reference/api" + @rm -rf "$(SOURCEDIR)/reference/api" + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..baa539a9 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,63 @@ +These are the documentation sources for PowSyBl optimizer. + +Please keep them up to date with your developments. +They are published on powsybl.readthedocs.io/ and pull requests are built and previewed automatically. + +When modifying the website content, you can easily preview the result on your PC. + +**First option - in a terminal, navigate to the root of the project and run the following commands:** + +~~~ +pip install -r docs/requirements.txt +sphinx-build -a docs ./build-docs +~~~ + +**Second option - run the following commands directly from your IDE GUI** + +~~~bash +pip install -r requirements.txt +~~~ + +~~~bash +sphinx-build -a . ../build-docs +~~~ + +**Preview the result** + +Then open `build-docs/index.html` in your browser. + +If you want to add links to another documentation, add the corresponding repository to the `conf.py` file. +To automatically get the version specified in the `pom.xml`, please use the same naming as the version: if you define the +Groovy version with ``, then use `groovy` as a key. The specified URL should start with `https://` and end with `latest/` (the final `/` is mandatory). +For example, to add a link to the documentation of Sphinx, you need to add the following lines: +~~~python +# This parameter might already be present, just add the new value +intersphinx_mapping = { + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), +} +~~~ + +Then in your documentation file, you can add links to powsybl-optimizer documentation. If you want to link to a whole page, +use one of the following examples: +~~~Markdown +- {doc}`sphinx:usage/extensions/intersphinx` +- {doc}`Intersphinx ` +- [Intersphinx](inv:sphinx:std:doc#usage/extensions/intersphinx). +~~~ + +If you want to link a specific part of a page, use one of those examples: +~~~Markdown +- [Intersphinx roles](inv:#ref-role). +- [Intersphinx roles](inv:sphinx#ref-role). +- [Intersphinx roles](inv:sphinx:std:label:#ref-role). +- [Intersphinx roles](inv:sphinx:*:*:#ref-role). +~~~ +*Note: for the last examples to work, there need to be a corresponding reference in the external documentation. +For those examples, `(ref-role)=` has been added right before the corresponding title +in the [Cross-referencing syntax page](inv:sphinx:std:doc#usage/referencing). Another way to make it work is to use the `autosectionlabel` module in Sphinx to +automatically generate anchors for each title.* + +*Note²: if the build fails, try with the `-E` option to clear the cache:* +~~~bash +sphinx-build -a -E docs ./build-docs +~~~ diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..2ea6b5c3fedc3d8a94789d101b6385e240bfe681 GIT binary patch literal 2017 zcmV<72Oju|P)EX>4Tx04R}tkvmAkKpe)uKBOWQK|6>#WT;LS#21cQg(6f4wL+^7CYQdTNkfw2 z;wZQl9DFQR9bBAsb#N5~!3T(wqm!bGl=#1-&?3fz<9>X1-^bl|fWKa5su>&uRLwF{ ziMWu-t_q=71Tly(dNCz2Q=b#XBs|C0J$!tC`-NgjguFvE0V2XsE=K#8E}nDBquP zS>e3JSuIyt^Pc>L;heUz%ypVWNMI355FtQD6(y8mAx5i4iis5M$36T5j$b5~Os*0b zITlcX3d!+<|H1EW&HTi;n-q=%9WS>1F${!ufkw@?zmILZaRLOMfh(=$uhfB=Ptt2G zEqVm>Yy%h9Elu77E_Z0RY(00006VoOIv0RI600RN!9r;`8x010qNS#tmY z4c7nw4c7reD4Tcy000McNlirueSad^gZEa<4bO1wgWnpw> zWFU8GbZ8()Nlj2!fese{00p^8L_t(o!?jmyP*i0Ye!g?gp0mqdKwuXz5OgCH5y;UL zl^hBa3V&GBOjc9IlsRQTtI2-Ul;%%=bQ#AGr^^s%Iu?$DgQJotcu5mo2F;0GmP;5c z%U;;a*>k>rz}{flCCvBN&bd6#bH4X^pZz|9c@}NnRt8FU10)Ru`^c7`n&*Q<9)P%J z+O3ZH2qFIiF&;$7oCKWQv17O1An#qZY61*H;|ryL`K$oXD?opJWi23m43K95dI}8l zX;VY$_Kr^VuHZANsR2}Oa$xNmHwY;D+6C~pfD9%O!ZGoJX~lMT4On~xkXis&W3`6F zAfDc1I%Z=m^@k04Rx2NMBRxHU+LTdbvVrI~v=ojqGL~YLv;eqx9wBjvXY{taTZxvI z6hsQy_t+2wB8P~{N(!=+#%XS}5Y{mERBw`sE;See3B~~M++mUL@Z-veI&`@*%>|B3 z8ncn6!lh&INVW))z}`bQgdE!mej8`8@a(sBdgSH#v8i$#%ZofS%r)6#f*eM~sKm|+ zYICr-(v*rbt-6p$rcce#4FUek405O+i0qHq%p+1rVWB6Acn(V%7GmRYWSWrSn|u^; zu-Ntb^`A&mc){#;7T2$r<8PW`~+^nAwptH_xRrNS2f6|F_=XB^B<*;zG2xF!P%vZXY z{gM5%8-knfpOIQEqo&4=2Q9|9#MhH3Uc-w*U{&xi-B!hNHH;b`1YvGilmceTdk6qD z*S@o1aF{#Tb4R%>7_(dSS{oV=J4GYRi6W|8@{ zA5ess+U;g=yDbSzj9%yqqQXwTZ{piorS+L3=3XUhFo;M_o*a{;BpC|}L2eYGeeHmFFq4^Zih#hq3Hd4g<#olJ%FA%YgzWlM>zC znJ6suqN>V{oE(1?vA>g>3J^a=!G@-wqQU`1h6LOI;3iXnCQJpI51T3-QORnzau{t@ zAlD~CH{}`f!Ls*dpN|O*Dj`5|@dVZvxS{N#$fjbHd&d+kuH~q(aibGT<twPMI}H=DO8&!JX+ud$I+;C zB6^^>)Ps}-5(WnN&;;1+9AIIvG07Ek`!%N^8q{%M%4IBEB*uM?WhvH`xsb2-p{+%W z_IsLy*mDvvEGh8g{!|nedQn|%M|QS9=5vufj@%u^6|iRY#189#Voz_ckdY|4BF!2p zB$l}n)sW0dBRcM9?uGBat^-ha?6r5_j3tBua8gzRChZ?7q_}tj<&qnD;!I+dAp01G z3ez{RLE_S*buY!-lm>+qxqTVNWS?&=4SVk*$q>0IjjX6GSwxw5!DLAjb`B162a^Wr zvI>JUia6o9;6iO}NqK$!O#oeO!diKMuD+d`OKVi3XQL_~p#laq%wfxc2 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/_static/styles/styles.css b/docs/_static/styles/styles.css new file mode 100644 index 00000000..f3340e11 --- /dev/null +++ b/docs/_static/styles/styles.css @@ -0,0 +1,6 @@ +/* The following code ensures font is not too big (Furo theme can make font too big on large screens) */ +@media(min-width:97em) { + html { + font-size: 100% + } +} \ No newline at end of file diff --git a/docs/_templates/page.html b/docs/_templates/page.html new file mode 100644 index 00000000..4652e049 --- /dev/null +++ b/docs/_templates/page.html @@ -0,0 +1,101 @@ + + +{% extends "furo/page.html" %} + +{% block footer %} +
+ {% if next -%} + +
+
+ {{ _("Next") }} +
+
{{ next.title }}
+
+ + + {%- endif %} + {% if prev -%} + + +
+
+ {{ _("Previous") }} +
+ {% if prev.link == pathto(master_doc) %} +
{{ _("Home") }}
+ {% else %} +
{{ prev.title }}
+ {% endif %} +
+ + {%- endif %} +
+
+
+ {%- if show_copyright %} +
+ {%- if hasdoc('copyright_year') %} + {% trans path=pathto('copyright_year'), copyright_year=copyright_year|e -%} +

+ Copyright © {{ copyright_year }}Authors of PowSyBl documentation. + Unless otherwise indicated, content is licensed under CC-BY-4.0. +

+

+ The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The + Linux Foundation, please see our Trademark + Usage page. Linux is a registered trademark of Linus Torvalds. +

+ {%- endtrans %} + {%- else %} + {% trans copyright=copyright|e -%} +

+ Copyright © {{ copyright_year }} Authors of PowSyBl documentation. + Unless otherwise indicated, content is licensed under CC-BY-4.0. +

+

+ The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The + Linux Foundation, please see our Trademark + Usage page. Linux is a registered trademark of Linus Torvalds. +

+ {%- endtrans %} + {%- endif %} +
+ {%- endif %} + {% trans %}Made with {% endtrans -%} + {%- if show_sphinx -%} + {% trans %}Sphinx and {% endtrans -%} + @pradyunsg's + {% endif -%} + {% trans %} + Furo + {% endtrans %} + {%- if last_updated -%} +
+ {% trans last_updated=last_updated|e -%} + Last updated on {{ last_updated }} + {%- endtrans -%} +
+ {%- endif %} +
+
+ {% if theme_footer_icons or READTHEDOCS -%} +
+ {% if theme_footer_icons -%} + {% for icon_dict in theme_footer_icons -%} + + {{- icon_dict.html -}} + + {% endfor %} + {%- endif %} +
+ {%- endif %} +
+
+{% endblock footer %} diff --git a/docs/_templates/sidebar/brand.html b/docs/_templates/sidebar/brand.html new file mode 100644 index 00000000..8aef92a7 --- /dev/null +++ b/docs/_templates/sidebar/brand.html @@ -0,0 +1,25 @@ +{#- +Overrides furo's brand.html to customize links: +- The logo links to a custom page (set sidebar_logo_href option in html_context) +- The title links to the subproject's main page +-#} + +{% if not theme_sidebar_hide_name %} + +{%- endif %} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..5fbe73ae --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,168 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import datetime +import os +import re +import sys + +# Path to python sources, for doc generation on readthedocs +source_path = os.path.abspath('..') +sys.path.insert(0, source_path) +print(f'appended {source_path}') + + +# -- Project information ----------------------------------------------------- + +# Only those 4 parameters have to be modified for each specific repository +project = 'powsybl-optimizer' +module_name = "powsybl-optimizer" +github_repository = "https://github.com/powsybl/powsybl-optimizer/" + +# Build year for the copyright +copyright_year = f'2018-{ datetime.datetime.now().year }' + +# Find the version and release information. +# We have a single source of truth for our version number: the project's pom.xml file. +# This next bit of code reads from it. +file_with_version = os.path.join(source_path, "pom.xml") +with open(file_with_version) as f: + next_line_contains_version = False + for line in f: + if next_line_contains_version == False: + m = re.match(r'^ {4}\' + module_name + r'\<\/artifactId\>', line) + if m: + next_line_contains_version = True + else: + m = re.match(r'^ {4}\(.*)\<\/version\>', line) + if m: + __version__ = m.group(1) + # The short X.Y version. + version = ".".join(__version__.split(".")[:2]) + # The full version, including alpha/beta/rc tags. + release = __version__ + break + else: # AKA no-break + version = release = "dev" + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.autosectionlabel', + 'sphinx.ext.autosummary', + 'sphinx.ext.viewcode', + 'sphinx.ext.doctest', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', + 'sphinx.ext.intersphinx', + 'sphinx_tabs.tabs', + 'myst_parser', + # Extension used to add a "copy" button on code blocks + 'sphinx_copybutton'] +myst_enable_extensions = [ + "amsmath", + "colon_fence", + "dollarmath", + "attrs_inline" +] +myst_heading_anchors = 6 + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# Reference sections generation +autosectionlabel_prefix_document = True +autosectionlabel_maxdepth = 2 + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "furo" + +html_title = f"{project} v{release}" + +html_logo = '_static/logos/logo_lfe_powsybl.svg' +html_favicon = "_static/favicon.ico" + +html_context = { + "copyright_year": copyright_year, + "sidebar_logo_href": "https://powsybl.readthedocs.io/", + "github_repository": github_repository +} + +html_theme_options = { + # the following 3 lines enable edit button + "source_repository": github_repository, + "source_branch": "main", + "source_directory": "docs/", +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] +html_css_files = ['styles/styles.css'] + +todo_include_todos = True + +# Links to external documentations +intersphinx_mapping = { + "powsyblcore": ("https://powsybl.readthedocs.io/projects/powsybl-core/en/latest/", None), +} +intersphinx_disabled_reftypes = ["*"] + +# Generate one file per method +autosummary_generate = True + + +# -- Dependencies versions --------------------------------------------------- +# This part will automatically look in the pom.xml to find versions corresponding to the dependencies whose +# documentation is used in the present one, except if it's a SNAPSHOT version or if a specific version has been chosen +# in intersphinx_mapping + +# Get the URL without the default version +def extract_base_url(url): + default_version = "latest" + + m = re.match(r'(^https\:\/\/.*)' + default_version + r'\/$', url) + if m: + return m.group(1) + +# Replace the default version in the URL with the version from the pom.xml +def replace_versions(intersphinx_mapping, file): + with open(file) as f: + for line in f: + m = re.match(r'^ {8}\<(.*)\.version\>(.*)\<\/(.*)\.version\>', line) + if m and m.group(1) == m.group(3): + dependency = m.group(1) + version = m.group(2) + if "SNAPSHOT" not in version and dependency in intersphinx_mapping: + url_start = extract_base_url(intersphinx_mapping[dependency][0]) + if url_start: + intersphinx_mapping[dependency] = (url_start + version + "/", None) + if "" in line: + break + return intersphinx_mapping + +intersphinx_mapping = replace_versions(intersphinx_mapping, file_with_version) diff --git a/docs/gettingStarted.md b/docs/gettingStarted.md new file mode 100644 index 00000000..21862fe1 --- /dev/null +++ b/docs/gettingStarted.md @@ -0,0 +1,23 @@ +# Getting started + +## AMPL +For this project, you must have [AMPL](https://ampl.com/) installed on your machine. +AMPL is a proprietary tool that works as an optimization modelling language, +and it can be interfaced with many solvers. + +To run OpenReac, you must add in your `~/.itools/config.yml` an ampl section like this: +```yaml +ampl: + # Change to the ampl folder path that contains the ampl executable + homeDir: /home/user/ampl +``` + +## Non-linear optimization solver + +To run the model implemented in AMPL, you'll need a non-linear optimization solver. +By default, the AMPL code is configured to run Knitro, which is a proprietary non-linear solver, but you +are free to configure a different one. + +If you chose to run Knitro, you must have `knitroampl` in your path, after the installation +of the solver is done and that you got a valid licence. + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..19e0c043 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,19 @@ +![PowSyBl Logo](_static/logos/logo_lfe_powsybl.svg) +# PowSyBl optimizer + +PowSyBl (Power System Blocks) is an open source library written in Java, +dedicated to electrical grid modeling, simulation and visualisation, licensed under the [Mozilla Public License version 2.0](https://www.mozilla.org/en-US/MPL/2.0/). +It is part of [LF Energy](https://www.lfenergy.org/), an open source foundation focused on the energy sector, hosted within The Linux Foundation. + +OpenReac is a reactive optimal power flow that gives a set of hypotheses for voltage and reactive controls by network equipment such as generators, shunt compensators and transformers. OpenReac can be used for network planning or in operation as well. + +```{toctree} +--- +maxdepth: 2 +hidden: true +gettingStarted.md +optimizer/index +--- + +``` + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..96ed7097 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd \ No newline at end of file diff --git a/docs/optimizer/_static/img/reactive-diagram.png b/docs/optimizer/_static/img/reactive-diagram.png new file mode 100644 index 0000000000000000000000000000000000000000..5d3fe2a380d84472c6dd927dcd6503df7161c0eb GIT binary patch literal 14258 zcmch;^9me8dZ z5pV(N_|D?%{rwX@KlqS6XJ*blbMEW9ult@k5jt8bH%RV~Kp>DCs*e@*AP_Sb^Rs|hg#{}FiVsVG1yhUwS9k4p{@H6KDC)v=@}*2LiVwdapbJs}VpR{TE#RXvtJ z5Qw;ns^UWfUyF^oYb`vhndi9n|9)dG3)jC^w|`cB>Gtuh!N3tSjOV(RR5}TWa-uq^|>axV^_T3xZxfGVX_MxiFs9E_%UO781EK#bIB+H(0CSgqARp{v;73ip7GHvYLq zEy_1qxKX2tLmVHuJ2D2ffQ1TS;Iv2+km8c*CQc;1Gg0qlq*5ct2lHsD^cCZrE3(h< zIQEJYRX3+7a>2Z&jyo+|!9eLa$i;efO(3Y?!&BR_> z`l<(G$WL84UHAM>MZd=*0n|$UwEfgvFEJRUL#_R>)tSOdPcM0DTX(^wV~+96lFY^L zesjIYU*VWQ^d)ujDZMTPk$Mq(ZbEo=qT2oZSc_cQjd2t6ybtWP^+ihWD3!J5+6Ma& zt~qKPHMN}ekn0(qFG)G5`TP9}E9=bt9t<aHh_f}MIIVRq45dlaeA*T+(bb~H1$`N;i#kk~x)ecmoXU78u?+8>N9LewCH`~}vG?BdnO!QY z87A3>&^#V7rM}lsfWjHQ@rd45O;^`L#%`Ny2+Pl?q@#b?`*$BQn=>xMmm@2_)ncCA zk!R!kT3&z=kF{{G)-$F{D{7;boXMsU^>%P_x6!N4KSo82#Hymb&=P$jb47bUIlUIx zwO;czwlD_s%hD8nF4D8E9g#bxl5fi**8g2Qp_TEw{rqhC#oQYv5>mu!vF9s~m)c&n z<|DQ)#t*1hzyjsGH%<&+#PJU(9RYM8RYt7hBgY^HlpXsY9O=Jgb zn#M4CPwHB8R}uJI{F3~*`qbPVgW-~G`UKvQBwf@-2F%toEsJ#5-G>}jxZtTe5T8qDPCh|pK+#}gzxxk|O0G&RptUOsL-tSehJyuHg#V^Xak%G7sP=jRi%H&N&HetqtfowWQWQR2B3SClY?UnbYDlW&b4ZCnc+r>zkf1J*j~* zmo-&87_=!QYJV-T*hXW~KU(TxRFt5Lr|aJrVGg61+k)`+*@&_p^X>?T)oHu6&k^j| zCMU+^k^#zQd9(Q&n%#aJv{Do@Cx5!wi*kbe8&%q=+x>PG0_&%i22l$*0g7a6~yI<^63Uxm(VIH&l zdCQbe+PyJb7x6|T37w2Wzp|eOzg}0k5|ytiPr?7fplmF`@0kHllW%`kli#zcv{cH> zTiRS&AuUAYcQM|NBiYzpZ3pzzH{3q8*eKd(WtwK>_a2uGsNmX;f;z>IgQGT45l&NJ zXiu8(`R%`F$bqMPxrNknT<rqAe@m<+4zH;sD-w8G|W^d~p zXB(V7lCM4s=l?mxm7Cd{3ctfcE7g>iZ_qMp^`tG5f21I9s|e%l$o>+g8)Gpx7)P1( zC`>=Y`;wN`8k6UUn!8b>hZg-Bs|@SSoKwz1UPw+|c5ck(YK<%_pZVFu{!*5IYQNuq zGk1y)ZU}1H_m8O$b8C7i1a^wMwA!D%NpWhp8~-AWcA!AG5o48sOg{9P7&kRPp9lR!dTcHUxievku@Lk!!!eYghnjt5LSZIMn|MJbD7-@$( zN!1CL*2@O_#(9ON+hTs?q?8THC1!}*QT(l%iwf!uj8SX1@02bR|7fx)j!A%R3S|w` zi}utW^`mN3$f$+XEV%4;|JJ^y${AV<(j3NSc8tqQlx-n4V3)f!vQb8S?i2-q`3$;T zK~$O!1K#o*D*NuXTKw{(`;Oyfl%%vd9bgqPG9oVZFfhYH@fIo-PXB>EwK1=$FGHK- z!cbZxmqgfe#=p@Ns--=&x`5^CRsGp zm*&ttp$@m`9JOm@m-?A0R2uSB>iEO#3OvTCFr)0dLmPe3Xj*#P-gk>R1+9I{h@y6H zMs`-3_xssVfT{ix*9I*@S=K z%BITFKBl(4WsGXmUYK(BNZiXB8ONlGX>N9ZVENFgYU!*QO3Dq!ebRE)A*>gr;`1`R0Po!l+dPdu8JXC_OIl;E+g5K*Ig1@HSk+;e z)Eok93hR>+Wm+pRs;Yg*j{clCxqtrEjrU{nP8!xAcz5txb8Ka)Y*WbG_3}OL zyzdOlmxm5~->5R0U*}X2H5D&GOPq7eP{H7ql}!Q4sOOxaUxzfDl+~1|{fE|bcHQGz zLWJcq460YwaBVCs*WWK>=AU3*J`Q_dKRu*&c!__x^CMrZb%~eFay}|Ab8PqZfHVI@ zYJGkGejhLQ^R{24B*oP_onxU%>M{(A+vZz`8ZKj72DtAZirW4PYQ=QS$~Y(X)S9x; zny23rHz(UYVh2kTmtPcbL3(lkGzj@6$(V zP^roBC412nmEh#qSgt4TXt>KHH7P5773tSUmYY#y5qm#xbL_@A^d`w8mt>NLBlq1~ z*;Ia|I=<<1ctHj)-=NZVR#oM2jk`HjUJYI#Du%HP|p(R+xjo2 zzaNxOe+VH|9#ql`>?yvqw00nuHDrCmv0gQ9Q5-2?Hg9H;L-lrhfNAH;`zdEVC;{_| zP2U7Y%XemKSw!ajG83n3QNAgs_|hZ~l|L_EexeGEEc1snc3O2Qg5Nv-nj{>M4v$8Y z?U$Zma?@h|ljU^}D)0}4K)4IOvnj=-FfB!v8vgPjDDa7O>Nj@a%%1sb8oA(9C@B6k zDjG3;1&zhq*A4s+HIyRi*MkJ- zjFn>d61L&L&Ri1?&yG?zgVPI-uRtKLbXq>{XY#`j<1-F#J&~GN`m4lA3&ZgwH*usF zR7hm>5Z_Pv1%c4L(ZAzjdF4H$gLu zel+@S%h{LvMFOoF^rM1)2KCJ|O$GT^ zY`elkbM2}kb>7ZrXEinxg;lRE*FWpqvNd`(Pyb>x#32>k6LcJQPvrUT*dcr{l8Ef8 zwBwI(=I!HD>MM+(MMvJ-m3={OulB-SUk`Bc=v=%Y$Jv#!Mxk9LS0xhh$(GCHi(Pp#a?c!LeX@(j2UH$)PB-?TWM)8C5kzcL(b_Q zI_k>?KW#6SZs537J#`$~k}rlo|KNl7GhU{KcGxpc{NLCh&{rY02><7K4rsFL$qTw3 z$*%0FT<4eDNgH`>C;1E&_g#?s8j8Fu8dm+&=5ZX2AcOis$x1$V*0o4dj&~?w13o*L zmlG@}z|udH#Iiq%F(r~m{spx@SJ`eIgRzw7io#G}gwFns+%CL!WY)jT@36Z521)VC zLxQgy9J%RNhz)jfL++@^{I(`1jqo^#WUjI0(-}8qi6Tw%O77V&=hhpqdwlc+^-ck$ z39DN3T+l{E?cZKdA=ZQ~Ve66FC-B<225rX555$R$R^u<`w3VJb;c-pelhxLNijtEQ zD}x8gTs&y<&tfNS+n*&B`6J!OiCxC@Y4!l1m!ViV%iU_&0>s42?s(0Sx^ z>!$Y$rUzGFnl$(hduCI9`YGXM38j{=6#}O1@Fdt^;qf8?1-IFTBzU8OUy$vN_p#@| zPW(UiEiLm0`_U1HxHp|{xLNl37`GpN?fT;DbsUMdd(oFtFXAce#dR6o^2m+iWXC%< z#Wis8E^T|ZdEXM7c#|p}L5RDbI?kVQRT|ZPe%$_c42RvLo+fRemPD2n2@cJS76izh z9cmp*+7?*gB8{oq)1L~BMN>hdO0vLjwWi|K3+I)ljz>(3leRPkC;**=%91T($CzY$~oID>cTbxL)Qm9n{)^YZht(; z@^IuoZOS*!-u=K%-JbkZ=y2=&Y)gP7S5#E@9Z@T8k@4L3Q!hh+!S-D049y2*0LuHE z8TDzJxSaAl`X2UOW$@`bs`A4V8ChI}_H_hgC0~a2ivQwI@?hVzReD=zv-iI?v7U^q z#OoQz#hhxQR`;!dh312#-)d~g#Qo-lQ@&`z)F{s^qSim(M}q1HJ>6xFzmJe17ANP% ziV72@8oh6m&y9^pknMJYX`NxFbv4;)c_B1VKR&Wug_-&vPmPfd z|L&zL)`9+t|3eoNj9tFiWe812({O0gKpn5|PR0Vga&KufLi?qqZ z7gD__`6Chir2!uj>W4MOR(f%XXP>QogjR*DWY072nUt{0ANHXt^U^ii_UbCbbRl;O z!GapCfYL%bY>A1Mb0>2#j~wnucds4A2ydF#t~t|)l8!H`G0aYS>UsP5T(`UfvC+!i zg#%?AcQK7NeyudXT9s*lwNju(jxN2GKd}bAzcRwptH%@W@4L!cb~^jtetz#B+)K1d z$O-+jb#ErBp131_P4od-nPP>@=bG%lWdcYBqu^c5W{p+#P@elLBg->1Ex-TcCq+PL zlq;{fTd{6Fe=D8nH(X5y=2$9!baLhG#DEuH8J0PWpm9yp?TIRzc)IuZI~{?$$eUM^ zH_P4N&S|R{lehK6CBT-TUW=A*Fk!7T+b;a*t)C>`OxP))33HkK&BKY*eTJMZY6d-H z(DQrs)^@FBXV{&E!3m875_WjG(lTF}2{eY`xQp=&iYBy5yLbTCbo~$goFfA|bN*9_ zqg_|&I>FI|ho}S+PMY_&5JxizPnrckrel0*hDK)T0r@q=x4>v$iRw}ou8N{^|y_!xV*UGZNbVm#<@?R#BM4C(n5O~~`E}aW0q$~=CektC%rfKa3FRu?FyvzZNYTbgn;ps;e zO*6Y9)^Lq^{T<;`>>j%E4i@i$n;t2pEC~U#iwt;Emiky z^|QAVg+jY=Un_$|qX|2FPnOu_)1J-Lmc(yOHGzi4vw7TPShZYXe7zzKipg~$2&wj8 zVrDe$^Pz3|LCh|H@R_`m!xwcAiOH?FB=rbQ2w7(WwlyxskRoncxWBECDCQ2;0*l+S zTflzJRMI+p>iBL?3!dN{7dwaP_qDr8tp7} zDif4N<5?yA6}epFpeNZ3&0x>}jKAbU8j|f%;c3<7;X*op&?Ejvck<`|#;^uB_Q&J+ znF+x0R70CL-DeSc_#>Ya+}DmbCu`cl>Cfg{n&LG!gZ7)>>O#1UW!SkxZ}ipi9(1$I zQ78-EP+`0&d4xsysIyrf_8WI{gd}liCnR;u1|3c0Xzk5bCG_v zm?fcC{tRbL1?8t28BnuwRiSrR1hihu>-ZKyeieY|Iutisc4;Nv+3e4tgPd@5{$@Ir1X|P&v!A(sUQoi8B0ps|- zxy=_10wj>d?UPmc_V_KTTHaK0VydYb!Cv|rGod`-wt{--mr)kG`ALEMKd#72MCbF8 zaFmq`4@*eXZo9d<+&9B49KPSfBfFGxrr43G=tB z7j1+<8{o1X$S>e!9`wpHC|6UoV93mIcEy(p`@yyCly-V$0xOvpzrR(Rp3^Cn0>%JvIPFM=WqPL(Gt7gCxiJlwOXlAz_s zb6Y_Gki{;aD}(-)g79?{gs(4B8?_Vve3~ZeABdn+Z{>FL0E0XPd>fLuih&w|h3q$O z^Pu~j|NI|FOu>YdJ3;K7!?VE88*Wz-CR8zPdHRGAM9si4eW#n}sg((?M*=u}(*)f+ zh{&%qo3MZ;p10hs#Ely}sry+l5=-wNbzTkm>|WuSiy`LseF%a^uFFGliK91K*I395 z=mUONb0x-jmXYxQpu+cVuL-ot7g2q0e@vv%lXbpVbY$4x;KtOERn=F&p z#q4?8PL|s?n6!Ab&Dj4nDgfREUg~%~gidNz>WUh8$=bn36I~q04uDj%dIO>YKohj> z2PlAgE9#MDwOp@N>4hc`p194|)T}R=|HO82%wcF60DjiZxBRUyb>vcytg2aU1HwlD ziPLiSw~`!zB~f8iUKOqM8*=Si`jDUnBF*J;UpZsKgmu`e6i^(a^;VJ+M*>p#g)H;c zGPW54K{xQXEh8xcdkgdp13~%=^~jo9Sv4@I3+!b@=Q~sB(A}uxm6&cCHdJMch5xqg z;t0|GhOE2e{Cg}m$cuF$YrkbRD-alb4S~HwOr^Ydw%;BM{2g;ECG`aO5)g3$3_0f~ ztK5fLxY{CF-e{ZK9JvA{jAwt|0`}ndAB(#1cXJSEF8qC47ivufxWLMMv_6*+H1!1r zS7`yzHz2>3cV117AS8L!0Cp%0;`_jAOkW@Y==3Up1jbXWN*4!c@f0iO^06n~@0WfK z(oEg2)TpATr-Fe-QI8u4)ECY%xTtO0z3+# zD`k$A`4qq9Xjb)vO6QTWOaxc8^8eWt%#r)1!uOV;jpiu8k`$iTfw%_#Mom%-od0o> z31vgeGVcHjrg77|@~$$(3O0W@?1LvI@5%skI@Cu1dVuPW-FJL9oGs1R-bNVWupKAAw(2JCAud314W;=4%gpx10#ySoQ}2IR`*F{~3m#4R|L%Ao;o<;E^T#fj>#{fiUO% zFsF;-$ZEE-aUFV%B_{6Zi;A2ceky-0&w&syxeL$}J-Ki?w~*vFj57}YYixZ9E;x^H zGna^vQ2yn1w&DgL3DiJUAs`0kUB+`9BN!M^>8bF%@vL_qh;mm?(e0;Z|3pJoA>anO z2QxI+yCh=UyfG{oy1ZJK&kN_L3vVeP&b>{;f+RG06kbv8F z!EM#)lMBHKQ4*s2k3b3i@@HO%0zX*nv!lv$sc49avyxnK_f^1U*tuS;I0?tDR)tIG zt?LktdY96ktJq6|!#+}>is!n}JRcG7d+d~&E<_;la#8?^S1m8yWzZp#Mzipr@_XzS zIhJ9I2~+`($qi9(!)_q)nBfC~f3l6Z3rY|+{}@eEoJS8dV6-lH&Ydf^5*)dsq+qd* z5-vjol#db&+}kE{$~vnq{Ia{W8@d+zUr(Q6um&Zh=W+1$e^a|oPCN<1K#SV-(RGV` zcTQuO2BA{`BltV5-=>HiYw;dPzTKD?3i;it-*EK)_0Fvr3e3->WS)SN5 z)Dx5Yb`W)Pym^Bcl{i{+kn?5`|-sT$^9*{rg|h&W(@lcSUx87 z0IMSZ1UM=l&TIg0moXJStss8@D57ioNe}-5LdJCEXqzz&Asv*!3SNyCb4K^*d!Pbv6{VCTa*Nh8woz!0aDvuCp!w!8+15esm13Wp$<|Z zcOV+&qiwK9=aErsKwir3Wo-pIc+Br)1MP@sEJtAMm@S^92V_=t&@bJBkI~=}(_0Ag z8p#L=|7ajl#0EhdeK5`TpmvOn7$6IOd}DxL>G%+aJnndm_CJn{KEVD&BEUTMJU zwK_|&YP+LBr4Q+qR1tO~ftQ^Rse^;pqHGMeAXig^Z?i4CW&#Q0^Mg5 zfHul248B&ZX?R*U8LPLF1<~jy-p(vw(8UiBhhH_ug)iJiNiqW5%fn&<$Oz<>@cu1a*t;_@qFe_TxGJXq(>`&f95Z6V?VqlGZR7 zF-f%>SF9q-h1aJto9?ltOU;0nGi!NGm@h!(#9ggG?mznKA7h481L1Ko$heV>lH3_C zHU-EReAwcip$WMFk}Inb3(zDWyhukwIvQJmb^w|eRSK*Ti1dC)AnJvpY`Db@vZaYwYTBq} z5YqCu;9CI+0JbLpDqz{6MIaWaCpw!w?}_ANw)vYJuxpJ2?yjC#&)bMq;+Oh9_R2mR zq6{3ln#J;LJ7qwIwigI=O6BU9}e zf?QiLfERYU{p_!+3n`iG?kIQ})2Eafr>k#*R?ImdRePb1uWnU&DQ%W0 zssIx}#ZEpr0U2;xF<^SSX<8WL~pQjw)~}${yqb-;mzU z03@tj+uE#B&tKi0%>^q+L?&@R8q%x-wJrou{0z$3K;87!hD*l~OaFXL$#tj&RQwXS z{m}u`gqv9tMgU)5lriwmv^1X522|tRe%t;H1eBVX>M0!1S`I!dE@q*;kX=B0x&`fI zSW^|}hbWYHk;}KlYk-VW8-Eiol@YOWQqhFXV2(z>U|cUFBfvWhpQ!>>w=$IBWEN6_ zM+Sm82^0xV_t5+o?!PL#Rf2baP&5!AS^Ae$Rdy4$;NH36->q8!8hs%|Z@Bq(skJqK zA9AHp4)MQ$-goY52)<+hf+ADtw#al}N`tiWy=Nv%^UYVh>qF9kW z8fDaCijf3{Z2~TTLjh_Wt5PcJ{O~n(Jl?Lz{RtHy5fNYD<~w=>f>ttcE-l%=lOU?g zB4lV)NZSFMu%|Q){s&T~M&JRI%Aqf2+A;Z-0Li?dfFYj>`}2|(WRdv1*?$NGrA}Ry zdxk4b07fBxb>R8(YWLl1|Ga-I^FiZ2p4hOmz<@`!ydC*<0Vt(&z%gT^_`r@YJhiOK z@`IqS4JI(A1Dpb%TnLcVPM=`!CNRg&9(GIbeXFwW*gX$N-~}T-Ndjqu>;7Q2IEkd>F;{7?F)dUcSUbs#~oj$y>FAj&NaN3Yy8IGz^U6T_4}Shult=<%!%25h z-78&G?d!%s%gC+}x)xrz(lk3=jVCA6qmOJC90X#h)$K^*qZsNdTa%-#qSOy@(b{Dd zI(nh`_yN9u%tXS|rg^_^)NBg&%ut!Bd(@Shm-{{jh5CD-aE(t%@ii=v3d=_mM(OK2 z@w|^DGau$6!wA_R?P%Huc#U%>snsk7s3u%$HEkumiQ^BeyJNdj{)$Y!W;E6&DF!?@ z60}!y!JBx^U{~3?_i?Ei)RpF~sZ7c+NkP|O21_J&skyU%_L=YXQ;X)iIO!(v&1-EX za3eJuzM3Fklx%*o$O0RJ)Haby=(g57abQqTuK$T2bU8vh&;}H80op1i4Jb)hn2IZ| zrWsi|1w5JbE#!n7!(h-76IF*guwACv@NQZ`6n|FG=g*-Wj`bleY(BOktK~TolI*1-4uZ!vhlT*{d*gwz;3WvvkxZTVqV#3 z?jDy{%*|9d1pS+K?q)v7Bf6YZ&fGY+;c6V%#GMAVSEfNFP=F7w+I>;nogAa@@V#(@ zG4^)99AR-5a_iEk3*+7<11mXM2t2fDr~@DZ3gT_Jcc57IZ&wXjvqRmWUSppUXsRjr zf!5D_X5w6x(YQ}uTIB%%!!dfHZI%r3s=>vK)dFY`izkE6u)6SHK@B^dhwW8PvQ$V>6bcL3r9_yi2Qlr zBiKPFEuS3N)dJyLfa}4uBqp%v08|edT(5eSN)Sp@S!SzuZE4xM4EM0ePfNu8)}<;2 zrPbK38w6ID6e>KsCAU9`h7@NWdI<)M>1D2`}?GmZyWBZ z-jP0!ek5@rlR3Z%-n_sfvCAEws8y^~Y8_{<_{~tzgZhB`Rn~+w7t-Cmg{7c(h>~)% zo&6l@3^A}TUiF`P5Mzza&I;H#FDzfopgG>41-s&7Dyv{u90-ixxuMK4U%-Akeco9NICO8Bqo>fvMVW?J)4WwfegC$V zJwfh7#`OLu1*okvk(2uN`s= zQ3Og)WyJaDx(MmQ3`MXvI1i=6gii~M3+{24cXi=5t45vRKT z?TMmmaML$E{NJOepl=w1HvZ3ZdC&yA`ULE*?*H>*Wp&; zkEDg6YLUo5|bcWhICRV6?0u#`GpQul3=Cn5re>6uPBat&CP z`6iqQntDv2WDtnI-CyEFnzyBo)%YjY?)h92};SbFPKfr{Eol&s1%S6D&9WL;IU*a zjarRfEg!H#wr++Hd~#tGg8v3U-TP>*NIORAS8*RG#>wLr>d_84a5nr7kL2a+1mFt> zD<=bq5-U9%NQ2qK$`ks)hK!Eug6D`Vdr{VlC*Mf$bs~rrCz;Hjj!%!JSoSy9JKcdy z+VrSgKfJb`8HK1Bmg0U^K0cV>ijY`N)bBLP&A~rDOHXjJR$zNW8X&E~K?r{ZQjSHR4_Hsu_mtW)g3ZNx`aiO7O*gtaAj_xde4`aFSs7x! z7fEP;#kqL;sW%O+7aJs^{B%jjvmS}k@atSbLJ8_@{0Ay>cGc)C?%rg-r=+3U)%QqM zVUa6QaerbJ2d8GCgp~fEltuCMJGHqyftDQTRT#wVN*}h+&29aNdgS*$`6~7n@gxZ+ zMI$&vo93s%XsgCxq4EP9LUgw-uwy!!K^Y{JctT7>R&$X)^Qb_D;>Vu(9;w;_hOjlU z{xD?LcD84J+n!u1TqT7g*XWCb{ZZ;7p_*!bOhQG}tKK&k%@0$L7vFSUfXXuA7ti=)!2s(sNDO2MK z&GeOS>E4~IgsO4ewJnVH^JA+CRok z^AmgEXr!s1lLt67K4HHV`Yu1@2?ed3_cYer>MOPKilUyl`m)cWVA2h%@0r0=HQmlB zg+oT7l1;nFQnr*Ep?QV-x1q`6`SqfP zuX!llFm~D;$0y?jiq=XemqxOjhMr8@X|Z_M7`R8hGM!k3R5{{UTb$B|gUu9iXkw)@E*=|2)5>S%ZVCEHPY0zraT0+G7Ww-5A0u3U_M* zpIfvejpC*?OX!vDCoPpuP5NN?Y{RyRGl}ntcd2x^F>6oZlaxk3*`EhGx!z%qgb^%v zi@M+%S@|4)kuX$VaS^fwF=$|e-_=d0w@G(lB;`QHxuBOs zM2Vn|$$wj#LSlEx@Z}$~;38HkS={1r6U5`e%JKTTlo|}_hScgfz7+CqJ0e{H6}4tJ z#2&9{pUsjzrg!GCIj%Cop@~j$E$WTSHaYs>J(I3~AB?HspTFK$#$GX;3HvQUu{2!8 zlWjc?&kAqh)iRK53qF#CrHV@4y%fThXgn@cFe*m-P!pV_l+^oqvgR_uhmP3FnXlku zB%IKJ{(Ya&Su6TD+rvm9^({CjC$DMI_F9FBU^J|;X{Gk|HvMY3DSNo&kp;3cvN3UI zt&H$`xGwasM&P^Psb%pw`*}HbWF<*mBIPyGF9co>hTUCA9?(KbHW1}bDQlV9Xc{jQ zH!2<3#hRK~Q@z0myKG@L_NrZ>toXMM?K2vsM9{l!iPQEaA*AqwAhoSgfo3){zFk_UOLY zvciTox@Z}8|1IH12N@y}7ncOe2%C9Mha3VfCnrWVE^k1uRgcquzNmz)&3iS=td(SVn2F-(0a zzZDtl%q6v(DqZKO1#W=MNw<0ll}e^*&E3?kL=A}!vrjePK>2A~I!mJ{SCsxAe^17p c(06{NEnwo|(bFv_5HcXDN?M8)3RW-wKlN#M*Z=?k literal 0 HcmV?d00001 diff --git a/docs/optimizer/acOptimalPowerflow.md b/docs/optimizer/acOptimalPowerflow.md new file mode 100644 index 00000000..13de4692 --- /dev/null +++ b/docs/optimizer/acOptimalPowerflow.md @@ -0,0 +1,88 @@ +# Alternative current optimal power flow + +## Generalities + +The goal of the reactive ACOPF is to compute voltage values on each bus, as well as control values for reactive equipment and controllers of the grid. +Then, the following values will be variable in the optimization: +- $\boldsymbol{V_i}$ and $\boldsymbol{\theta_i}$ the voltage magnitude and phase of bus $i$. +- $\boldsymbol{P_{i,g}}$ (resp. $\boldsymbol{Q_{i,g}}$) the active (resp. reactive) power produced by variable generator $g$ of bus $i$. +- $\boldsymbol{Q_{i,vsc}}$ the reactive power produced by voltage source converter stations $vsc$ of bus $i$. +- $\boldsymbol{b_{i,g}}$ (resp. $\boldsymbol{b_{i,svc}}$) the susceptance of shunt $s$ (resp. of static var compensator $svc$) of bus $i$. +- $\boldsymbol{\rho_{ij}}$ the transformer ratio of the ratio tap changer on branch $ij$, +specified as variable by the user (see [3.2](#32-configuration-of-the-run)). + +Please note that: +- Units with active power specified in `ampl_network_generators.txt` that is less than the configurable parameter `Pnull` **are excluded from the optimization**, + even if the user designates these generators as fixed in the parameter file `param_generators_reactive.txt` (see [3.2](#32-configuration-of-the-run)). + Therefore, when the optimization results are exported, **these generators are exported with a reactive power target of $0$**. +- **Neither current limits nor power limits** on branches are considered in the optimization. + +## Constraints + +The constraints of the optimization problem depend on parameters specified by the user (see [3.2](#32-configuration-of-the-run)). +In particular, the user can indicate which buses will have associated **reactive slacks** $\boldsymbol{\sigma_{i}^{Q,+}}$ and $\boldsymbol{\sigma_{i}^{Q,-}}$ +, expressing the excess (resp. shortfall) of reactive power produced in bus $i$, and used to ensure reactive power balance. +To do so, these buses must be specified in parameter file `param_buses_with_reactive_slack.txt`, and `buses_with_reactive_slacks` must be set to $\text{CONFIGURED}$. + +The ACOPF involves the following constraints, in addition to the slack constraint $(1)$ introduced in [5](#5-slack-bus--main-connex-component): + +$$\sum\limits_{j\in v(i)} \boldsymbol{p_{ij}} = P_i^{in} - \sum\limits_{g}\boldsymbol{P_{i,g}}, \quad i\in\text{BUSCC} \quad (5)$$ + +$$\sum\limits_{j\in v(i)} \boldsymbol{q_{ij}} = Q_i^{in} - \boldsymbol{\sigma_{i}^{Q,+}} + \boldsymbol{\sigma_{Q_i}^{-}} - \sum\limits_{g}\boldsymbol{Q_{i,g}} - \sum\limits_{vsc}\boldsymbol{Q_{i,vsc}} - \sum\limits_{s}\boldsymbol{b_{i,s}}{V_i}^2 - \sum\limits_{svc}\boldsymbol{b_{i,svc}}{V_i}^2, \quad i\in\text{BUSCC} \quad (6)$$ + +where: +- $\boldsymbol{p_{ij}}$ (resp. $\boldsymbol{q_{ij}}$) is the active (resp. reactive) power leaving bus $i$ on branch $ij$, + calculated as defined in the [PowSyBl documentation](https://powsybl.readthedocs.io/projects/powsybl-open-loadflow). + Those are variables because they depend on $\boldsymbol{V_i}$, $\boldsymbol{V_j}$, $\boldsymbol{\theta_i}$, $\boldsymbol{\theta_j}$ and $\boldsymbol{\rho_{ij}}$. +- $P_i^{in}$ is the constant active power injected or consumed in bus $i$ by batteries, loads, VSC stations and LCC stations. +- $Q_i^{in}$ is the constant reactive power injected or consumed in bus $i$, by fixed generators and fixed shunts (see [3.2](#32-configuration-of-the-run)), batteries, loads and LCC stations. + +In order to bound the variables described in [7.1](#71-generalities), the limits specified in the files of network data (see [3.1](#31-network-data)) +are used. We specify the following special treatments: +- The voltage magnitude $\boldsymbol{V_i}$ lies between the corrected voltage limits described in [4.1](#41-voltage-level-limits-consistency). +- The reactive power $\boldsymbol{Q_{i,g}}$ produced by unit $g$ lies between the corrected limits described in [4.4](#44-pq-units-domain). +- The active power $\boldsymbol{P_{i,g}}$ also lies between the corrected limits described in [4.4](#44-pq-units-domain), +but these bounds are only considered when the configurable parameter $\alpha$ is different than $1$ (default value). +Otherwise, all active powers evolve proportionally to their initial point $P_{i,g}^t$ (specified in `ampl_network_generators.txt`): +$\boldsymbol{P_{i,g}} = P_{i,g}^t + \boldsymbol{\gamma} (P_{g}^{max,c} - P_{i,g}^t)$, where $\boldsymbol{\gamma}$ is optimized and lies in $\[-1;1\]$. +- The reactive power $\boldsymbol{Q_{i,vsc}}$ produced by voltage source converter station $vsc$ is included in $\[\min(qP_{vsc}, qp_{vsc}, qp_{vsc}^0)$; $\max(QP_{vsc}, Qp_{vsc}, Qp_{vsc}^0)\]$. +**The bounds are therefore rectangular, not trapezoidal.** + +## Objective function + +The objective function also depends on parameters specified by the user (see [3.2](#32-configuration-of-the-run)). +The `objective_choice` parameter modifies the values of penalties $\beta_1$, $\beta_2$, and $\beta_3$ in the objective function: +if `objective_choice` $= i$, then $\beta_i = 1$ and $\beta_j = 0.01$ for $j \neq i$. + +Specifically, if `objective_choice` takes on: +- $0$, the minimization of active power production $\sum\limits_{i,g}\boldsymbol{P_{i,g}}$ is prioritized. +- $1$, the minimization of $\sum\limits_{i} \boldsymbol{V_i}-(\rho V_i^{c,max} - (1-\rho)V_i^{c,min})^2$ is prioritized ($\rho$ +equals the configurable parameter `ratio_voltage_target`). +- $2$, the minimization of $\sum\limits_{i} (\boldsymbol{V_i} - V_i^t)^2$ is prioritized. + +The objective function of the ACOPF is: +$$\text{minimize} \left( 10\sum\limits_{i} (\boldsymbol{\sigma_{i}^{Q,+}} + \boldsymbol{\sigma_{i}^{Q,-}}) + \beta_1 \sum\limits_{g} \left( \alpha\boldsymbol{P_{i,g}} + (1-\alpha)(\frac{\boldsymbol{P_{i,g}} - P_{i,g}^t}{\max(1, |P_{i,g}^t|)})^2 \right) + \beta_2 \sum\limits_{i} \left( \boldsymbol{V_i} - (1-\rho)V_{i}^{min,c} + \rho V_{i}^{max,c} \right)^2 + \beta_3 \sum\limits_{i} (\boldsymbol{V_i} - V_i^t)^2 + 0.1 \sum\limits_{g} \left(\frac{\boldsymbol{Q_{i,g}}}{\max(1,Q_{g}^{min,c}, Q_{g}^{max,c})}\right)^2 + 0.1 \sum\limits_{ij} (\boldsymbol{\rho_{ij}} - \rho_{ij})^2 \right)$$ + +where: +- $P_{i,g}^t$ (resp. $V_i^t$) is the active target (resp. voltage initial point) specified in `ampl_network_generators.txt` (resp. `ampl_network_buses.txt`). +- $\rho_{ij}$ is the transformer ratio of line $ij$, specified in `ampl_network_tct.txt`. + +The sum of the reactive slack variables is penalized by a +high coefficient ($10$) to drive it towards $0$, ensuring reactive power balance at each bus of the network. + +## Solving + +Before solving the ACOPF, the voltage magnitudes $\boldsymbol{V_i}$ are warm-started with $V_i^t$ +(specified in `ampl_network_buses.txt`), as well as the voltage phases $\boldsymbol{\theta_i}$ with the results of the DCOPF (see [6](#6-direct-current-optimal-power-flow)). +Please also note that a scaling is applied with user-defined values before solving the ACOPF. + +The solving is considered as successful if the non-linear solver employed (see [Non-linear solver](#non-linear-optimization-solver)) +finds a feasible approximate solution (**even if the sum of +slacks is important**), and the script `reactiveopfoutput.run` is executed (see [8.1](#81-in-case-of-convergence)). + +Note that if the solving of ACOPF fails, and the $\alpha$ parameter is set to $1$ (default value), +then a new resolution is attempted, with $\alpha$ set to zero. This gives more freedom to the active powers +produced (see [7.2](#72-constraints)), leaving these variables free withing their respective bounds. + +If ACOPF solving fails another time, the script `reactiveopfexit.run` is executed (see [8.2](#82-in-case-of-inconsistency)). + diff --git a/docs/optimizer/dcOptimalPowerflow.md b/docs/optimizer/dcOptimalPowerflow.md new file mode 100644 index 00000000..510d3051 --- /dev/null +++ b/docs/optimizer/dcOptimalPowerflow.md @@ -0,0 +1,29 @@ +# Direct current optimal power flow + +## Generalities + +Before addressing the ACOPF (see [AC optimal powerflow](acOptimalPowerflow.md)), a DCOPF is solved for two main reasons: +- If the DCOPF resolution fails, it provides a strong indication that the ACOPF resolution will also fail. + Thus, it serves as a formal consistency check on the data. +- The phases computed by DCOPF resolution will be used as initial points for the solving of the ACOPF. + +## Optimization problem + +The DCOPF model involves the following constraints, in addition to the slack constraint $(1)$ introduced in [Slack bus and main connex component](slackBusMainConnexComponent.md): + +$$\sum\limits_{j\in v(i)} \boldsymbol{p_{ij}} = P_i^{in} + \boldsymbol{\sigma_{P,i}^{+}} - \boldsymbol{\sigma_{P,i}^{-}} - \sum\limits_{g}\boldsymbol{P_{i,g}}, \quad i\in\text{BUSCC} \quad (4)$$ + +where: +- $\boldsymbol{p_{ij}}$ is the active power leaving bus $i$ on branch $ij$, defined as $\boldsymbol{p_{ij}} = \frac{\boldsymbol{\theta_i} - \boldsymbol{\theta_j}}{X_{ij}}$, where $X_{ij}$ is the reactance of line $ij$ (specified in `ampl_network_branches.txt`). +- $P_i^{in}$ the constant active power injected or consumed in bus $i$ (by batteries, loads, VSC stations and LCC stations). +- $\boldsymbol{P_{i,g}}$ is the variable active power produced by generators of bus $i$. +- $\boldsymbol{\sigma_{P,i}^{+}}$ (resp. $\boldsymbol{\sigma_{P,i}^{-}}$) is a positive slack variable expressing the excess (resp. shortfall) of active power produced in bus $i$. + +And the following objective function: + +$$\text{minimize} \left(1000 \sum\limits_{i} (\boldsymbol{\sigma_{i}^{P,+}} + \boldsymbol{\sigma_{i}^{P,-}}) + \sum\limits_{g} \left(\frac{\boldsymbol{P_{i,g}} - P_{i,g}^{t}}{\max(1, \frac{P_{i,g}^t}{100})}\right)^2\right)$$ + +where $P_{i,g}^{t}$ is the target of the generator $g$ on bus $i$. + +The sum of the active slack variables ($\boldsymbol{\sigma_{i}^{P,+}}$ and $\boldsymbol{\sigma_{i}^{P,-}}$) is penalized by a high coefficient ($1000$) to drive it towards $0$, ensuring active power balance at each bus of the network. +The solving of the DCOPF is considered as successful if this sum **does not exceed** the configurable threshold `Pnull` (see [Configuration of the run](inputs.md#configuration-of-the-run)), and if the non-linear solver employed (see [Non-linear optimization solver](../gettingStarted.md#non-linear-optimization-solver)) finds a feasible solution without reaching one of its default limit. Otherwise, the solving is considered unsuccessful and the script `reactiveopfexit.run` is executed (see [In case of inconsistency](outputs.md#in-case-of-inconsistency)). diff --git a/docs/optimizer/divisionOfCode.md b/docs/optimizer/divisionOfCode.md new file mode 100644 index 00000000..152f94e6 --- /dev/null +++ b/docs/optimizer/divisionOfCode.md @@ -0,0 +1,23 @@ +# Division of the code + +The code of the reactive OPF is divided into several files, each serving a specific function: + +- `reactiveopf.dat` defines the network data files imported (files with *ampl_* prefix), and the files used to configure the run (files with *param_* prefix). + See [Inputs](inputs.md). + +- `iidm_importer.mod`, `or_param_importer.mod` and `commons.mod` define the sets and parameters of the optimization. + +- `connected_component.mod`, `dcopf.mod` and `acopf.mod` define the optimization problems solved in `reactiveopf.run`. + See [Slack bus and main connex components](slackBusMainConnexComponent.md), [DC optimal power flow](dcOptimalPowerflow.md) and [AC optimal power flow](acOptimalPowerflow.md), respectively. + +- `connected_component.run`, `dcopf.run`, `acopf_preprocessing.run` and `acopf.run` orchestrate the optimization and its post-process. + +- `reactiveopfoutput.mod` exports result files if the execution of `reactiveopf.run` is successful. + See [Outputs](outputs.md#in-case-of-convergence). + +- `reactiveopfexit.run` contains the code executed when the process fails. + Refer to section [8.2](outputs.md#in-case-of-inconsistency). + +- `reactiveopf.run` executes the AMPL process of OpenReac, calling the previous scripts. + + diff --git a/docs/optimizer/index.md b/docs/optimizer/index.md new file mode 100644 index 00000000..fc3b60ad --- /dev/null +++ b/docs/optimizer/index.md @@ -0,0 +1,26 @@ +# Overview + +The reactive optimal power flow (OPF) is implemented with AMPL. +Its goal is to compute voltage values on each point of the network as well as control values for reactive equipment and controllers of the grid (voltage set point of generating units, shunts, transformer ratios...). + +In a grid development study, you decide new equipment, new generating units, new substations, new loads, you set values for active and reactive loads, you set values for active power generation and HVDC flows. +Then if you wish to do AC powerflow simulations with N-1 analysis, you need all voltage and reactive set points and this reactive OPF is your solution. + +Please notice that this reactive OPF does **not** decide active power of generating units and HVDC branches. + + +```{toctree} +--- +maxdepth: 2 +hidden: true +divisionOfCode.md +inputs.md +preprocessing.md +slackBusMainConnexComponent.md +dcOptimalPowerflow.md +acOptimalPowerflow.md +outputs.md +--- + +``` + diff --git a/docs/optimizer/inputs.md b/docs/optimizer/inputs.md new file mode 100644 index 00000000..f64cb62e --- /dev/null +++ b/docs/optimizer/inputs.md @@ -0,0 +1,61 @@ +# Inputs + +## Network data + +Files with the prefix `ampl_` contain the data and the parameters of the network on which the reactive OPF is executed. +These files are obtained by using the [extended version of PowSyBl AMPL export](inv:powsyblcore:*:*:#the-extendedamplexporter), which is the default version. + +## Configuration of the run + +The user can configure the run with the dedicated Java interface +(see [OpenReacParameters](../open-reac/src/main/java/com/powsybl/openreac/parameters/input/OpenReacParameters.java)). +Specifically, the user can set various parameters and thresholds used in the preprocessing and modeling of the reactive OPF. +These are specified in the file `param_algo.txt`: + +| Parameter | Description | Java default value | Domain | +|---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|-----------------------------------------------| +| `log_level_ampl` | Level of display for AMPL prints | INFO | {DEBUG, INFO, WARNING, ERROR} | +| `log_level_knitro` | Level of display for solver prints (see [AMPL documentation](https://dev.ampl.com/ampl/options.html)) | $1$ | {0, 1, 2} | +| `objective_choice` | Choice of the objective function for the ACOPF (see [AC optimal powerflow](acOptimalPowerflow.md)) | $0$ | {0, 1, 2} | +| `ratio_voltage_target` | Ratio to calculate target V of buses when `objective_choice` is set to $1$ (see [AC optimal powerflow](acOptimalPowerflow.md)) | $0.5$ | $\[0; 1\]$ | +| `coeff_alpha` | Weight to favor more/less minimization of active power produced by generators or deviation between them and target values (see [AC optimal powerflow](acOptimalPowerflow.md)) | $1$ | $\[0; 1\]$ | +| `Pnull` | Threshold of active and reactive powers considered as null | $0.01$ (MW) | $\[0; 1\]$ | +| `Znull` | Threshold of impedance considered as null (see [Zero impedance threshold](preprocessing.md#zero-impedance-threshold)) | $10^{-5}$ (p.u.) | $\[0; 0.1\]$ | + | `epsilon_nominal_voltage` | Threshold to ignore voltage levels with nominal voltage lower than it | $1$ (kV) | $\mathbb{R}^{+}$ | +| `min_plausible_low_voltage_limit` | Consistency bound for low voltage limit of voltage levels (see [Voltage level limit consistency](preprocessing.md#voltage-level-limit-consistency)) | $0.5$ (p.u.) | $\mathbb{R}^{+}$ | +| `max_plausible_high_voltage_limit` | Consistency bound for high voltage limit of voltage levels (see [Voltage level limit consistency](preprocessing.md#voltage-level-limit-consistency)) | $1.5$ (p.u.) | [`min_plausible_low_voltage_limit`; $\infty$] | +| `ignore_voltage_bounds` | Threshold to replace voltage limits of voltage levels with nominal voltage lower than it, by [min_plausible_low_voltage_limit; max_plausible_high_voltage_limit] | $0$ (p.u.) | $\mathbb{R}^{+}$ | +| `buses_with_reactive_slacks` | Choice of which buses will have reactive slacks attached in ACOPF solving (see [AC optimal powerflow](acOptimalPowerflow.md)) | ALL | {CONFIGURED, NO_GENERATION, ALL} | +| `PQmax` | Threshold for maximum active and reactive power considered in correction of generator limits (see [PQ unit domain](preprocessing.md#pq-unit-domain)) | $9000$ (MW, MVAr) | $\mathbb{R}$ | +| `defaultPmax` | Threshold for correction of high active power limit produced by generators (see [PQ unit domain](preprocessing.md#pq-unit-domain)) | $1000$ (MW) | $\mathbb{R}$ | +| `defaultPmin` | Threshold for correction of low active power limit produced by generators (see [PQ unit domain](preprocessing.md#pq-unit-domain)) | $0$ (MW) | $\mathbb{R}$ | +| `defaultQmaxPmaxRatio` | Ratio used to calculate threshold for corrections of high/low reactive power limits (see [PQ unit domain](preprocessing.md#pq-unit-domain)) | $0.3$ (MVAr/MW) | $\mathbb{R}$ | +| `minimalQPrange` | Threshold to fix active (resp. reactive) power of generators with active (resp. reactive) power limits that are closer than it (see [PQ unit domain](preprocessing.md#pq-unit-domain)) | $1$ (MW, MVAr) | $\mathbb{R}$ | +| `default_variable_scaling_factor` | Default scaling factor applied to all the variables (except reactive slacks and transformer ratios) before ACOPF solving | $1$ | $\mathbb{R}^{*,+}$ | +| `default_constraint_scaling_factor` | Default scaling factor applied to all the constraints before ACOPF solving | $1$ | $\mathbb{R}^{+}$ | +| `reactive_slack_variable_scaling_factor` | Scaling factor applied to all reactive slacks variables before ACOPF solving (see [AC optimal powerflow](acOptimalPowerflow.md)) | $0.1$ | $\mathbb{R}^{*,+}$ | +| `transformer_ratio_variable_scaling_factor` | Scaling factor applied to all transformer ratio variables before ACOPF solving (see [AC optimal powerflow](acOptimalPowerflow.md)) | $0.001$ | $\mathbb{R}^{*,+}$ | +| `shunt_variable_scaling_factor` | Scaling factor applied to all shunt variables before ACOPF solving (see [AC optimal powerflow](acOptimalPowerflow.md)) | $0.1$ | $\mathbb{R}^{*,+}$ | + +Please note that for these parameters, the AMPL code defines default values which may be different from those in Java (for example, for the scaling values). This allows a user to use the AMPL code without going through the Java interface, and without providing the file `param_algo.txt`. + +In addition to the previous parameters, the user can specify which parameters will be variable or fixed in the ACOPF solving (see [AC optimal powerflow](acOptimalPowerflow.md)). +This is done using the following files: + +| File | Description | Default behavior of modified values | +|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| `param_transformers.txt` | Ratio tap changers with a variable transformation ratio (real variable) | Transformation ratios are fixed | +| `param_shunt.txt` | Shunts with a continuous variable susceptance and which can be modified and/or connected (only if possible bus is defined in `ampl_network_shunts.txt`) | Shunt susceptances are fixed | +| `param_generators_reactive.txt` | Generators with a constant reactive power production. If this value is not consistent (> PQmax), the reactive power production stays variable | Coherent reactive power productions (see [4.5](#45-pq-units-domain)) are variable | +| `param_buses_with_reactive_slack.txt` | Buses with attached reactive slacks if configurable parameter buses_with_reactive_slacks = "CONFIGURED" | Only buses with no reactive power production have reactive slacks attached | + +All of these files share the same format: 2 columns #"num" "id". + +Once again, the user can directly execute the AMPL code without passing these parameters files as input. +If so, empty files will be created during execution. + +## New voltage limits + +In addition to the elements specified in section [Configuration of the run](#configuration-of-the-run), the user may choose to override the voltage limits of specified voltage levels. These values must be defined in `ampl_network_substations_override.txt` and are employed to establish the new voltage limits as specified in section [Voltage level limit consistency](preprocessing.md#voltage-level-limit-consistency). + +Format of `ampl_network_substations_override.txt`: 4 columns #"num" "minV (pu)" "maxV (pu)" "id" diff --git a/docs/optimizer/outputs.md b/docs/optimizer/outputs.md new file mode 100644 index 00000000..912ffb37 --- /dev/null +++ b/docs/optimizer/outputs.md @@ -0,0 +1,35 @@ +# Outputs + +## In case of convergence + +After the solving of the ACOPF, the script `reactiveopfoutput.run` is executed + and the following files (except `reactiveopf_results_indic.txt`) are exported only if the solving +is considered as successful (see [7](#7-alternative-current-optimal-power-flow)): + +| File | Content | Format | +|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| `reactiveopf_results_indic.txt` | General information (system OS, computation time, etc.). The configurable thresholds/parameters (see section [3.2](#32-configuration-of-the-run)). The cardinality of the sets (number of non-impedance branches, number of slack variables, etc.). Information about calculated angles (maximum/minimum theta, maximum difference between neighbors, etc.). | | +| `reactiveopf_results_static_var_compensators.csv` | Calculated voltage and reactive power values for the SVC that regulate voltage. | 6 columns #"variant" "num" "bus" "vRegul" "V(pu)" "Q(MVAr)" | +| `reactiveopf_results_shunts.csv` | Calculated reactive power (and susceptance) values for shunts that were either connected or modified after the optimization problems were resolved. | 6 columns #"variant" "num" "bus" "b(pu)" "Q(MVAr)" "section" | +| `reactiveopf_results_generators.csv` | Calculated active and reactive power values for generating units. | 9 columns #"variant" "num" "bus" "vRegul" "V(pu)" "targetP(MW)" "targetQ(MVAr)" "P(MW)" "Q(MW)" | +| `reactiveopf_results_vsc_converter_stations.csv` | Calculated reactive power values for VSC converter stations. | 8 columns #"variant" "num" "bus" "vRegul" "targetV(pu)" "targetQ(MVAr)" "P(MW)" "Q(MVAr)" | +| `reactiveopf_results_rtc.csv` | RTCs and associated taps, with transformer ratio closest to the one calculated after the optimization. | 3 columns #"variant" "num" "tap" | +| `reactiveopf_results_reactive_slacks.csv` | Calculated reactive slack variables $\boldsymbol{\sigma^{Q,-}}$ and $\boldsymbol{\sigma^{Q,+}}$. | 6 columns #"variant" "bus" "slack_condensator(MVAr)" "slack_self(MVAr)" "id" "substation" | +| `reactiveopf_results_voltages.csv` | Calculated voltages for each bus of the main connex component (see [5](#5-slack-bus--main-connex-component)). | 5 columns #"variant" "bus" "V(pu)" "theta(rad)" "id" | + +If ACOPF solving is not successful, the user can export the following optional files (aiding for the analysis of ACOPF results) by specifying the + ampl log parameter to a debug level (see [3.2](#32-configuration-of-the-run)): + +| File | Content | Format | +|--------------------------------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| +| `debug_bus.csv` | Information on calculated voltages (values, bounds, repartition, etc.). | 13 columns #"bus_id" "Vnom" "V" "Vlb" "Vub" "Vmin_mod" "Vmax_mod" "Vmin_OK" "Vmax_OK" "Vmin_ori" "Vmax_ori" "sQ1" "sQ2" | +| `reactiveopf_results_generators_Pnull.csv` | Information on units that are excluded from the solving of ACOPF (see [7](#7-alternative-current-optimal-power-flow)). | 11 columns #"variant" "num" "bus" "vRegul" "V(pu)" "targetP(MW)" "targetQ(Mvar)" "P(MW)" "Q(MW)" "id" "bus_id" | + +## In case of inconsistency + +If the computation of the main connex component (see [5](#5-slack-bus--main-connex-component)) or +of the DCOPF fails (see [6](#6-direct-current-optimal-power-flow)), +the problem is considered as inconsistent. +Then, the script `reactiveopfexit.run` is executed and the file `reactiveopf_results_indic.txt` described in [8.1](#81-in-case-of-convergence) + is exported, without the information on the calculated angles. + diff --git a/docs/optimizer/preprocessing.md b/docs/optimizer/preprocessing.md new file mode 100644 index 00000000..59b49c5a --- /dev/null +++ b/docs/optimizer/preprocessing.md @@ -0,0 +1,56 @@ +# Pre-processing + +Before solving the reactive ACOPF described in [AC optimal powerflow](acOptimalPowerflow.md), the following pre-processing blocks are executed to ensure the consistency of the values used in the optimization. + +##Voltage level limit consistency + +To ensure consistent voltage level limits for the buses, the configurable domain [`min_plausible_low_voltage_limit`; `max_plausible_high_voltage_limit`] is used (see [Configuration of the run](inputs.md#configuration-of-the-run)). + +Let $V_{s}^{min}$ (resp. $V_{s}^{max}$) be the low (resp. high) voltage limit of substation $s$ specified in `ampl_network_substations.txt` (or in `ampl_network_substations_override.txt` if an override is given for $s$) and $V_{s}^{min,c}$ (resp. $V_{s}^{max,c}$) its associated corrected low (resp. high) limit. Then, the limits are calculated as follows: +- $V_{s}^{min,c} = \max(V_{s}^{min},$ min_plausible_low_voltage_limit) +- $V_{s}^{max,c} = \min(V_{s}^{max},$ max_plausible_low_voltage_limit) + +## Zero-impedance branches + +Branches with an impedance magnitude, **calculated in per unit**, lower than the configurable threshold `Znull` (see section [Configuration of the run](inputs.md#configuration-of-the-run)) are considered as non-impedant. +These branches will have their reactance replaced by the threshold `Znull` (in p.u.), **even if the reactance specified in `ampl_network_branches.txt` is negative**. + +## Impedance of transformers + +In the calculations of the ACOPF (see [AC optimal powerflow](acOptimalPowerflow.md)), the transformers with an impedance (specified in `ampl_network_branches.txt`) considered as null (see [Zero-impedance branches](preprocessing.md#zero-impedance-branches)) **are treated as lines**. Then, the transformation ratios/phase shifts are ignored, as well as the impedance specified in the tap changer table `ampl_network_tct.txt`. + +For phase shifters transformers considered as impedant, the reactance values from the tap changer table (in `ampl_network_tct.txt`) replace the reactance specified in `ampl_network_branches.txt`. The resistance is then calculated proportionally. +For the ratio tap changers, the impedance stays as specified in `ampl_network_branches.txt`. **Please notice there is no specified handling for cases where resistance and/or reactance is negative or if there is both a ratio tap changer and a phase shift transformer on the same branch.** + +## P/Q unit domain + +The following corrections apply successively to determine consistent domains for the active power and reactive power produced by generators. + +To determine the consistent domain of produced active power, the bounds of the domains $P_g^{min}$ and $P_g^{max}$, as well as the target $P_g^{t}$ of generator $g$ (all specified in `ampl_network_generators.txt`) are used. + +Let $P_{g}^{min,c}$ and $P_{g}^{max,c}$ be the corrected active bounds: + +- By default, $P_{g}^{min,c} = \text{defaultPmin}$ and $P_{g}^{max,c} = \text{defaultPmax}$ (see [Configuration of the run](inputs.md#configuration-of-the-run)) +- If $|P_g^{max}| \geq \text{PQmax}$, then $P_{g}^{max,c} = \max(\text{defaultPmax}, P_g^t)$ +- If $|P_g^{min}| \geq \text{PQmax}$, then $P_{g}^{min,c} = \min(\text{defaultPmin}, P_g^t)$ +- If $|P_{g}^{max,c} - P_{g}^{min,c}| \leq \text{minimalQPrange}$, then $P_{g}^{max,c} = P_{g}^{min,c} = P_{g}^t$ (active power is fixed). + +To determine the consistent domain of produced reactive power, the reactive power diagram (specified in `ampl_network_generators.txt`) of generator $g$ is used: $qp_g$ (resp. $qP_g$) and $Qp_g$ ($QP_g$) when $P_{g}^{min,c}$ (resp. $P_{g}^{max,c}$) is reached. +Let $qp_g^c$ (resp. $qP_g^c$) and $Qp_g^c$ (resp. $QP_g^c$) be the bounds of the corrected reactive diagram, and $Q_{g}^{min,c}$ and $Q_{g}^{max,c}$ be the corrected reactive bounds: + +- By default, $qp_g^{c} = qP_{g}^{c} = - \text{defaultPmin} \times \text{defaultQmaxPmaxRatio}$ and $Qp_{g}^{c} = QP_{g}^{c} = \text{defaultPmax} \times \text{defaultQmaxPmaxRatio}$ (see [Configuration of the run](inputs.md#configuration-of-the-run)) +- If $|qp_{g}| \geq \text{PQmax}$, then $qp_{g}^{c} = -\text{defaultQmaxPmaxRatio} \times P_{max}^{g,c}$. + Same with $qP_{g}^{c}$. +- If $|Qp_{g}| \geq \text{PQmax}$, then $Qp_{g}^{c} = \text{defaultQmaxPmaxRatio} \times P_{max}^{g,c}$. + Same with $QP_{g}^{c}$. +- If $qp_{g}^{c} > Qp_{g}^{c}$, the values are swapped. + Same with $qP_{g}^{c}$ and $QP_{g}^{c}$. +- If the corrected reactive diagram is too small (the distances between the vertices of the reactive diagram are lower than $\text{minimalQPrange}$), then $qp_{g}^{c} = Qp_{g}^{c} = qP_{g}^{c} = QP_{g}^{c} = \frac{qp_{g}^{c} + Qp_{g}^{c} + qP_{g}^{c} + QP_{g}^{c}}{4}$ (reactive power is fixed). +- $Q_{g}^{min,c} = \min(qp_{g}^{c}, qP_{g}^{c})$ and $Q_{g}^{max,c} = \min(Qp_{g}^{c}, QP_{g}^{c})$ + +Please note that in the end, **the corrected bounds are rectangular**, not trapezoidal, and they are used only in the reactive OPF (see [AC optimal powerflow](acOptimalPowerflow.md). The trapezoidal diagram should be added shortly. +In addition, bounds $qP_{g}^0$ and $Qp_{g}^0$ are not used, as generators with zero active power will be excluded from the optimisation (see [AC optimal powerflow](acOptimalPowerflow.md#generalities)). + +The general correction of the generator's reactive power diagram $g$ is illustrated in the following figure: +![Reactive diagram correction](_static/img/reactive-diagram.png){width="30%" align=center} + diff --git a/docs/optimizer/slackBusMainConnexComponent.md b/docs/optimizer/slackBusMainConnexComponent.md new file mode 100644 index 00000000..cd317005 --- /dev/null +++ b/docs/optimizer/slackBusMainConnexComponent.md @@ -0,0 +1,23 @@ +# Slack bus and main connex component + +The slack bus $s$ is determined by identifying the bus with the **highest number of AC branches connected**, within the main component (`cc` set to $0$ in `ampl_network_buses.txt`). +If multiple buses have such cardinality, the one with the highest identifier (`num` parameter) is chosen. +In the event no bus satisfies these conditions, the first bus defined in `ampl_network_buses.txt` is selected. + +The OPFs are executed on the **main connex component** (i.e. buses connected to slack bus by AC branches) of the network. +Consequently, **buses connected to the slack only by HVDC lines are excluded**. + +This component is determined by solving the following optimization problem (the variables are bolded): + +$$\text{maximize} \left(\sum\limits_{i} \boldsymbol{\theta_i^{cc}}\right)$$ + +where $\boldsymbol{\theta_i^{cc}}$ is the voltage angle of bus $i$, and with the following constraints: + +$$\boldsymbol{\theta_s^{cc}} = 0 \quad (1)$$ + +$$\boldsymbol{\theta_i^{cc}} - \boldsymbol{\theta_j^{cc}} = 0, \quad ij \in BRANCH \quad (2)$$ + +$$0 \leq \boldsymbol{\theta_i^{cc}} \leq 1, \quad i \in BUS \quad (3)$$ + +If the solving is unsuccessful, the script `reactiveopfexit.run` is executed (see [In case of inconsistency](outputs.md#in-case-of-inconsistency)) and the execution is stopped. +The sets of buses and branches belonging to the main connex component are now denoted $BUSCC$ and $BRANCHCC$, respectively. diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..c410d7c5 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +sphinx==7.1.2 +sphinx-tabs +furo==2024.1.29 +myst-parser +sphinx-copybutton \ No newline at end of file