-
Notifications
You must be signed in to change notification settings - Fork 67
/
Copy pathindex.html
2 lines (2 loc) · 11.2 KB
/
index.html
1
2
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Welcome Page · PowerSimulations.jl</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href><img src="assets/logo.png" alt="PowerSimulations.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href>PowerSimulations.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Welcome Page</a><ul class="internal"><li><a class="tocitem" href="#Overview"><span>Overview</span></a></li><li><a class="tocitem" href="#How-the-documentation-is-structured"><span>How the documentation is structured</span></a></li><li><a class="tocitem" href="#Installation"><span>Installation</span></a></li></ul></li><li><a class="tocitem" href="quick_start_guide/">Quick Start Guide</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="tutorials/decision_problem/">Single-step Problem</a></li><li><a class="tocitem" href="tutorials/pcm_simulation/">Multi-stage Production Cost Simulation</a></li></ul></li><li><span class="tocitem">Modeler Guide</span><ul><li><a class="tocitem" href="modeler_guide/definitions/">Definitions</a></li><li><a class="tocitem" href="modeler_guide/psi_structure/">PowerSimulations.jl Modeling Structure</a></li><li><a class="tocitem" href="modeler_guide/problem_templates/">Operations <code>ProblemTemplate</code>s</a></li><li><a class="tocitem" href="modeler_guide/running_a_simulation/">Simulation</a></li><li><a class="tocitem" href="modeler_guide/simulation_recorder/">Simulation Recorder</a></li><li><a class="tocitem" href="modeler_guide/logging/">Logging</a></li><li><a class="tocitem" href="modeler_guide/tips_and_tricks/">Tips and tricks</a></li><li><a class="tocitem" href="modeler_guide/debugging_infeasible_models/">Debugging infeasible models</a></li><li><a class="tocitem" href="modeler_guide/parallel_simulations/">Parallel Simulations</a></li><li><a class="tocitem" href="modeler_guide/modeling_faq/">Modeling FAQ</a></li></ul></li><li><span class="tocitem">Model Developer Guide</span><ul><li><a class="tocitem" href="model_developer_guide/structure_of_operation_problem/">Operation Problem Structure</a></li><li><a class="tocitem" href="model_developer_guide/troubleshooting/">Troubleshooting</a></li></ul></li><li><span class="tocitem">Code Base Developer Guide</span><ul><li><a class="tocitem" href="code_base_developer_guide/developer/">Developer Guide</a></li><li><a class="tocitem" href="code_base_developer_guide/troubleshooting/">Troubleshooting</a></li></ul></li><li><span class="tocitem">Formulation Library</span><ul><li><a class="tocitem" href="formulation_library/General/">General</a></li><li><a class="tocitem" href="formulation_library/ThermalGen/">Thermal Generation</a></li><li><a class="tocitem" href="formulation_library/RenewableGen/">Renewable Generation</a></li><li><a class="tocitem" href="formulation_library/Load/">Load</a></li><li><a class="tocitem" href="formulation_library/Network/">Network</a></li><li><a class="tocitem" href="formulation_library/Branch/">Branch</a></li></ul></li><li><a class="tocitem" href="api/PowerSimulations/">API Reference</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"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Welcome Page</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Welcome Page</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/NREL-Sienna/PowerSimulations.jl/blob/main/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="PowerSimulations.jl"><a class="docs-heading-anchor" href="#PowerSimulations.jl">PowerSimulations.jl</a><a id="PowerSimulations.jl-1"></a><a class="docs-heading-anchor-permalink" href="#PowerSimulations.jl" title="Permalink"></a></h1><h2 id="Overview"><a class="docs-heading-anchor" href="#Overview">Overview</a><a id="Overview-1"></a><a class="docs-heading-anchor-permalink" href="#Overview" title="Permalink"></a></h2><p><code>PowerSimulations.jl</code> is a power system operations simulation tool developed as a flexible and open source software for quasi-static power systems simulations including Production Cost Models. <code>PowerSimulations.jl</code> tackles the issues of developing a simulation model in a modular way providing tools for the formulation of decision models and emulation models that can be solved independently or in an interconnected fashion.</p><p><code>PowerSimulations.jl</code> supports the workflows to develop simulations by separating the development of operations models and simulation models.</p><ul><li><strong>Operation Models</strong>: Optimization model used to find the solution of an operation problem.</li><li><strong>Simulations Models</strong>: Defined the requirements to find solutions to a sequence of operation problems in a way that resembles the procedures followed by operators.</li></ul><p>The most common Simulation Model is the solution of a Unit Commitment and Economic Dispatch sequence of problems. This model is used in commercial Production Cost Modeling tools, but it has a limited scope of analysis.</p><h2 id="How-the-documentation-is-structured"><a class="docs-heading-anchor" href="#How-the-documentation-is-structured">How the documentation is structured</a><a id="How-the-documentation-is-structured-1"></a><a class="docs-heading-anchor-permalink" href="#How-the-documentation-is-structured" title="Permalink"></a></h2><p><code>PowerSimulations.jl</code> documentation and code are organized according to the needs of different users depending on their skillset and requirements. In broad terms there are three categories:</p><ul><li><p><strong>Modeler</strong>: Users that want to solve an operations problem or run a simulation using the existing models in <code>PowerSimulations.jl</code>. For instance, answer questions about the change in operation costs in future fuel mixes. Check the formulations library page to choose a modeling strategy that fits your needs.</p></li><li><p><strong>Model Developer</strong>: Users that want to develop custom models and workflows for the simulation of a power system operation. For instance, study the impacts of an stochastic optimization problem over a deterministic.</p></li><li><p><strong>Code Base Developers</strong>: Users that want to add new core functionalities or fix bugs in the core capabilities of <code>PowerSimulations.jl</code>.</p></li></ul><p><code>PowerSimulations.jl</code> is an active project under development, and we welcome your feedback, suggestions, and bug reports.</p><p><strong>Note</strong>: <code>PowerSimulations.jl</code> uses the data model implemented in <a href="https://github.com/NREL-Sienna/PowerSystems.jl"><code>PowerSystems.jl</code></a> to construct optimization models. In most cases, you need to add <code>PowerSystems.jl</code> to your scripts.</p><h2 id="Installation"><a class="docs-heading-anchor" href="#Installation">Installation</a><a id="Installation-1"></a><a class="docs-heading-anchor-permalink" href="#Installation" title="Permalink"></a></h2><p>The latest stable release of PowerSimulations can be installed using the Julia package manager with</p><pre><code class="language-julia hljs">] add PowerSimulations</code></pre><p>For the current development version, "checkout" this package with</p><pre><code class="language-julia hljs">] add PowerSimulations#main</code></pre><p>An appropriate optimization solver is required for running PowerSimulations models. Refer to <a href="https://jump.dev/JuMP.jl/stable/installation/#Install-a-solver"><code>JuMP.jl</code> solver's page</a> to select the most appropriate for the application of interest.</p><hr/><p>PowerSystems has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory (<a href="https://www.nrel.gov/">NREL</a>).</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="quick_start_guide/">Quick Start Guide »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Wednesday 6 September 2023 22:30">Wednesday 6 September 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>