parent
d81fa649a7
commit
06fef2706f
@ -0,0 +1,228 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="shortcut icon" href="/img/favicon.ico">
|
||||||
|
|
||||||
|
|
||||||
|
<title>UnitCommitment.jl</title>
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/all.css">
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/v4-shims.css">
|
||||||
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
|
||||||
|
<link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
|
||||||
|
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
|
||||||
|
<link href="/css/bootstrap-custom.min.css" rel="stylesheet">
|
||||||
|
<link href="/css/base.min.css" rel="stylesheet">
|
||||||
|
<link href="/css/cinder.min.css" rel="stylesheet">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/styles/github.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link href="/css/custom.css" rel="stylesheet">
|
||||||
|
|
||||||
|
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/respond.js@1.4.2/dest/respond.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
||||||
|
<div class="container">
|
||||||
|
|
||||||
|
<!-- Collapsed navigation -->
|
||||||
|
<div class="navbar-header">
|
||||||
|
<!-- Expander button -->
|
||||||
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
|
||||||
|
<span class="sr-only">Toggle navigation</span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
</button>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Main title -->
|
||||||
|
|
||||||
|
|
||||||
|
<a class="navbar-brand" href="/.">UnitCommitment.jl</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Expanded navigation -->
|
||||||
|
<div class="navbar-collapse collapse">
|
||||||
|
<!-- Main navigation -->
|
||||||
|
<ul class="nav navbar-nav">
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="/.">Home</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="/usage/">Usage</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="/format/">Format</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="/instances/">Instances</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<ul class="nav navbar-nav navbar-right">
|
||||||
|
<li>
|
||||||
|
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
|
||||||
|
<i class="fas fa-search"></i> Search
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="https://github.com/ANL-CEEESA/unitcommitment.jl/"><i class="fab fa-github"></i> GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="container">
|
||||||
|
|
||||||
|
|
||||||
|
<div class="row-fluid">
|
||||||
|
<div id="main-content" class="span12">
|
||||||
|
<h1 id="404-page-not-found" style="text-align: center">404</h1>
|
||||||
|
<p style="text-align: center"><strong>Page not found</strong></p>
|
||||||
|
<p style="text-align: center"><a href="/">Home</a></p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer class="col-md-12 text-center">
|
||||||
|
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
<p>
|
||||||
|
<small>Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved.</small><br>
|
||||||
|
|
||||||
|
<small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
|
||||||
|
<script src="/js/bootstrap-3.0.3.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js"></script>
|
||||||
|
|
||||||
|
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/languages/julia.min.js"></script>
|
||||||
|
|
||||||
|
<script>hljs.initHighlightingOnLoad();</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var base_url = "/"</script>
|
||||||
|
|
||||||
|
<script src="/js/base.js"></script>
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||||
|
<script src="/js/mathjax.js"></script>
|
||||||
|
<script src="/search/main.js"></script>
|
||||||
|
|
||||||
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-dialog modal-lg">
|
||||||
|
<div class="modal-content">
|
||||||
|
<div class="modal-header">
|
||||||
|
<button type="button" class="close" data-dismiss="modal">
|
||||||
|
<span aria-hidden="true">×</span>
|
||||||
|
<span class="sr-only">Close</span>
|
||||||
|
</button>
|
||||||
|
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<p>
|
||||||
|
From here you can search these documents. Enter
|
||||||
|
your search terms below.
|
||||||
|
</p>
|
||||||
|
<form>
|
||||||
|
<div class="form-group">
|
||||||
|
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
<div id="mkdocs-search-results"></div>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-dialog">
|
||||||
|
<div class="modal-content">
|
||||||
|
<div class="modal-header">
|
||||||
|
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
||||||
|
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<table class="table">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th style="width: 20%;">Keys</th>
|
||||||
|
<th>Action</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td class="help shortcut"><kbd>?</kbd></td>
|
||||||
|
<td>Open this help</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="next shortcut"><kbd>n</kbd></td>
|
||||||
|
<td>Next page</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="prev shortcut"><kbd>p</kbd></td>
|
||||||
|
<td>Previous page</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="search shortcut"><kbd>s</kbd></td>
|
||||||
|
<td>Search</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
@ -0,0 +1,289 @@
|
|||||||
|
html {
|
||||||
|
scroll-padding-top: 70px;
|
||||||
|
}
|
||||||
|
|
||||||
|
body {
|
||||||
|
padding-top: 70px;
|
||||||
|
}
|
||||||
|
|
||||||
|
p > img {
|
||||||
|
max-width: 100%;
|
||||||
|
height: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.nav li.first-level {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.nav li.third-level {
|
||||||
|
padding-left: 12px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.col-md-3 {
|
||||||
|
padding-left: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.col-md-9 {
|
||||||
|
padding-bottom: 100px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.source-links {
|
||||||
|
float: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Side navigation
|
||||||
|
*
|
||||||
|
* Scrollspy and affixed enhanced navigation to highlight sections and secondary
|
||||||
|
* sections of docs content.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* By default it's not affixed in mobile views, so undo that */
|
||||||
|
.bs-sidebar.affix {
|
||||||
|
position: static;
|
||||||
|
}
|
||||||
|
|
||||||
|
.bs-sidebar.well {
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* First level of nav */
|
||||||
|
.bs-sidenav {
|
||||||
|
margin-top: 30px;
|
||||||
|
margin-bottom: 30px;
|
||||||
|
padding-top: 10px;
|
||||||
|
padding-bottom: 10px;
|
||||||
|
border-radius: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* All levels of nav */
|
||||||
|
.bs-sidebar .nav > li > a {
|
||||||
|
display: block;
|
||||||
|
padding: 5px 20px;
|
||||||
|
z-index: 1;
|
||||||
|
}
|
||||||
|
.bs-sidebar .nav > li > a:hover,
|
||||||
|
.bs-sidebar .nav > li > a:focus {
|
||||||
|
text-decoration: none;
|
||||||
|
border-right: 1px solid;
|
||||||
|
}
|
||||||
|
.bs-sidebar .nav > .active > a,
|
||||||
|
.bs-sidebar .nav > .active:hover > a,
|
||||||
|
.bs-sidebar .nav > .active:focus > a {
|
||||||
|
font-weight: bold;
|
||||||
|
background-color: transparent;
|
||||||
|
border-right: 1px solid;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Nav: second level (shown on .active) */
|
||||||
|
.bs-sidebar .nav .nav {
|
||||||
|
display: none; /* Hide by default, but at >768px, show it */
|
||||||
|
margin-bottom: 8px;
|
||||||
|
}
|
||||||
|
.bs-sidebar .nav .nav > li > a {
|
||||||
|
padding-top: 3px;
|
||||||
|
padding-bottom: 3px;
|
||||||
|
padding-left: 30px;
|
||||||
|
font-size: 90%;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Show and affix the side nav when space allows it */
|
||||||
|
@media (min-width: 992px) {
|
||||||
|
.bs-sidebar .nav > .active > ul {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
/* Widen the fixed sidebar */
|
||||||
|
.bs-sidebar.affix,
|
||||||
|
.bs-sidebar.affix-bottom {
|
||||||
|
width: 213px;
|
||||||
|
}
|
||||||
|
.bs-sidebar.affix {
|
||||||
|
position: fixed; /* Undo the static from mobile first approach */
|
||||||
|
top: 80px;
|
||||||
|
max-height: calc(100% - 180px);
|
||||||
|
overflow-y: auto;
|
||||||
|
}
|
||||||
|
.bs-sidebar.affix-bottom {
|
||||||
|
position: absolute; /* Undo the static from mobile first approach */
|
||||||
|
}
|
||||||
|
.bs-sidebar.affix-bottom .bs-sidenav,
|
||||||
|
.bs-sidebar.affix .bs-sidenav {
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media (min-width: 1200px) {
|
||||||
|
/* Widen the fixed sidebar again */
|
||||||
|
.bs-sidebar.affix-bottom,
|
||||||
|
.bs-sidebar.affix {
|
||||||
|
width: 263px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/* Added to support >2 level nav in drop down */
|
||||||
|
|
||||||
|
.dropdown-submenu {
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dropdown-submenu>.dropdown-menu {
|
||||||
|
top: 0;
|
||||||
|
left: 100%;
|
||||||
|
margin-top: 0px;
|
||||||
|
margin-left: 0px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dropdown-submenu:hover>.dropdown-menu {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dropdown-submenu>a:after {
|
||||||
|
display: block;
|
||||||
|
content: " ";
|
||||||
|
float: right;
|
||||||
|
width: 0;
|
||||||
|
height: 0;
|
||||||
|
border-color: transparent;
|
||||||
|
border-style: solid;
|
||||||
|
border-width: 5px 0 5px 5px;
|
||||||
|
border-left-color: #ccc;
|
||||||
|
margin-top: 5px;
|
||||||
|
margin-right: -10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dropdown-submenu:hover>a:after {
|
||||||
|
border-left-color: #fff;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dropdown-submenu.pull-left {
|
||||||
|
float: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dropdown-submenu.pull-left>.dropdown-menu {
|
||||||
|
left: -100%;
|
||||||
|
margin-left: 00px;
|
||||||
|
}
|
||||||
|
/* Start Bootstrap Callouts CSS Source by Chris Pratt (https://codepen.io/chrisdpratt/pen/IAymB) MIT License*/
|
||||||
|
.bs-callout {
|
||||||
|
padding: 20px;
|
||||||
|
margin: 20px 0;
|
||||||
|
border: 1px solid #eee;
|
||||||
|
border-left-width: 5px;
|
||||||
|
border-radius: 3px;
|
||||||
|
background-color: #FCFDFF;
|
||||||
|
}
|
||||||
|
.bs-callout h4 {
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 400;
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 5px;
|
||||||
|
}
|
||||||
|
.bs-callout p:last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
.bs-callout code {
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
.bs-callout+.bs-callout {
|
||||||
|
margin-top: -5px;
|
||||||
|
}
|
||||||
|
.bs-callout-default {
|
||||||
|
border-left-color: #FA023C; /*modified from upstream default by Christopher Simpkins*/
|
||||||
|
}
|
||||||
|
.bs-callout-default h4 {
|
||||||
|
color: #FA023C; /*modified from upstream default by Christopher Simpkins*/
|
||||||
|
}
|
||||||
|
.bs-callout-primary {
|
||||||
|
border-left-color: #428bca;
|
||||||
|
}
|
||||||
|
.bs-callout-primary h4 {
|
||||||
|
color: #428bca;
|
||||||
|
}
|
||||||
|
.bs-callout-success {
|
||||||
|
border-left-color: #5cb85c;
|
||||||
|
}
|
||||||
|
.bs-callout-success h4 {
|
||||||
|
color: #5cb85c;
|
||||||
|
}
|
||||||
|
.bs-callout-danger {
|
||||||
|
border-left-color: #d9534f;
|
||||||
|
}
|
||||||
|
.bs-callout-danger h4 {
|
||||||
|
color: #d9534f;
|
||||||
|
}
|
||||||
|
.bs-callout-warning {
|
||||||
|
border-left-color: #f0ad4e;
|
||||||
|
}
|
||||||
|
.bs-callout-warning h4 {
|
||||||
|
color: #f0ad4e;
|
||||||
|
}
|
||||||
|
.bs-callout-info {
|
||||||
|
border-left-color: #5bc0de;
|
||||||
|
}
|
||||||
|
.bs-callout-info h4 {
|
||||||
|
color: #5bc0de;
|
||||||
|
}
|
||||||
|
/* End Bootstrap Callouts CSS Source by Chris Pratt */
|
||||||
|
|
||||||
|
/* Headerlinks */
|
||||||
|
.headerlink {
|
||||||
|
display: none;
|
||||||
|
padding-left: .5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .headerlink, h5:hover .headerlink, h6:hover .headerlink {
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Admonitions */
|
||||||
|
.admonition {
|
||||||
|
padding: 20px;
|
||||||
|
margin: 20px 0;
|
||||||
|
border: 1px solid #eee;
|
||||||
|
border-left-width: 5px;
|
||||||
|
border-radius: 3px;
|
||||||
|
background-color: #FCFDFF;
|
||||||
|
}
|
||||||
|
|
||||||
|
.admonition p:last-child {
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
.admonition code {
|
||||||
|
border-radius: 3px;
|
||||||
|
}
|
||||||
|
.admonition+.admonition {
|
||||||
|
margin-top: -5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.admonition.note { /* csslint allow: adjoining-classes */
|
||||||
|
border-left-color: #428bca;
|
||||||
|
}
|
||||||
|
|
||||||
|
.admonition.warning { /* csslint allow: adjoining-classes */
|
||||||
|
border-left-color: #f0ad4e;
|
||||||
|
}
|
||||||
|
|
||||||
|
.admonition.danger { /* csslint allow: adjoining-classes */
|
||||||
|
border-left-color: #d9534f;
|
||||||
|
}
|
||||||
|
|
||||||
|
.admonition-title {
|
||||||
|
font-size: 19px;
|
||||||
|
font-style: normal;
|
||||||
|
font-weight: 400;
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.admonition.note > .admonition-title {
|
||||||
|
color: #428bca;
|
||||||
|
}
|
||||||
|
|
||||||
|
.admonition.warning > .admonition-title {
|
||||||
|
color: #f0ad4e;
|
||||||
|
}
|
||||||
|
|
||||||
|
.admonition.danger > .admonition-title {
|
||||||
|
color: #d9534f;
|
||||||
|
}
|
||||||
@ -0,0 +1 @@
|
|||||||
|
html{scroll-padding-top:70px}body{padding-top:70px}p>img{max-width:100%;height:auto}ul.nav li.first-level{font-weight:bold}ul.nav li.third-level{padding-left:12px}div.col-md-3{padding-left:0}div.col-md-9{padding-bottom:100px}div.source-links{float:right}.bs-sidebar.affix{position:static}.bs-sidebar.well{padding:0}.bs-sidenav{margin-top:30px;margin-bottom:30px;padding-top:10px;padding-bottom:10px;border-radius:5px}.bs-sidebar .nav>li>a{display:block;padding:5px 20px;z-index:1}.bs-sidebar .nav>li>a:hover,.bs-sidebar .nav>li>a:focus{text-decoration:none;border-right:1px solid}.bs-sidebar .nav>.active>a,.bs-sidebar .nav>.active:hover>a,.bs-sidebar .nav>.active:focus>a{font-weight:bold;background-color:transparent;border-right:1px solid}.bs-sidebar .nav .nav{display:none;margin-bottom:8px}.bs-sidebar .nav .nav>li>a{padding-top:3px;padding-bottom:3px;padding-left:30px;font-size:90%}@media(min-width:992px){.bs-sidebar .nav>.active>ul{display:block}.bs-sidebar.affix,.bs-sidebar.affix-bottom{width:213px}.bs-sidebar.affix{position:fixed;top:80px;max-height:calc(100% - 180px);overflow-y:auto}.bs-sidebar.affix-bottom{position:absolute}.bs-sidebar.affix-bottom .bs-sidenav,.bs-sidebar.affix .bs-sidenav{margin-top:0;margin-bottom:0}}@media(min-width:1200px){.bs-sidebar.affix-bottom,.bs-sidebar.affix{width:263px}}.dropdown-submenu{position:relative}.dropdown-submenu>.dropdown-menu{top:0;left:100%;margin-top:0;margin-left:0}.dropdown-submenu:hover>.dropdown-menu{display:block}.dropdown-submenu>a:after{display:block;content:" ";float:right;width:0;height:0;border-color:transparent;border-style:solid;border-width:5px 0 5px 5px;border-left-color:#ccc;margin-top:5px;margin-right:-10px}.dropdown-submenu:hover>a:after{border-left-color:#fff}.dropdown-submenu.pull-left{float:none}.dropdown-submenu.pull-left>.dropdown-menu{left:-100%;margin-left:00px}.bs-callout{padding:20px;margin:20px 0;border:1px solid #eee;border-left-width:5px;border-radius:3px;background-color:#fcfdff}.bs-callout h4{font-style:normal;font-weight:400;margin-top:0;margin-bottom:5px}.bs-callout p:last-child{margin-bottom:0}.bs-callout code{border-radius:3px}.bs-callout+.bs-callout{margin-top:-5px}.bs-callout-default{border-left-color:#fa023c}.bs-callout-default h4{color:#fa023c}.bs-callout-primary{border-left-color:#428bca}.bs-callout-primary h4{color:#428bca}.bs-callout-success{border-left-color:#5cb85c}.bs-callout-success h4{color:#5cb85c}.bs-callout-danger{border-left-color:#d9534f}.bs-callout-danger h4{color:#d9534f}.bs-callout-warning{border-left-color:#f0ad4e}.bs-callout-warning h4{color:#f0ad4e}.bs-callout-info{border-left-color:#5bc0de}.bs-callout-info h4{color:#5bc0de}.headerlink{display:none;padding-left:.5em}h1:hover .headerlink,h2:hover .headerlink,h3:hover .headerlink,h4:hover .headerlink,h5:hover .headerlink,h6:hover .headerlink{display:inline-block}.admonition{padding:20px;margin:20px 0;border:1px solid #eee;border-left-width:5px;border-radius:3px;background-color:#fcfdff}.admonition p:last-child{margin-bottom:0}.admonition code{border-radius:3px}.admonition+.admonition{margin-top:-5px}.admonition.note{border-left-color:#428bca}.admonition.warning{border-left-color:#f0ad4e}.admonition.danger{border-left-color:#d9534f}.admonition-title{font-size:19px;font-style:normal;font-weight:400;margin-top:0;margin-bottom:5px}.admonition.note>.admonition-title{color:#428bca}.admonition.warning>.admonition-title{color:#f0ad4e}.admonition.danger>.admonition-title{color:#d9534f}
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
@ -0,0 +1,88 @@
|
|||||||
|
/*
|
||||||
|
Cinder Theme for MkDocs | Copyright 2015 Christopher Simpkins | MIT License
|
||||||
|
*/
|
||||||
|
|
||||||
|
body {
|
||||||
|
font-family:"Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||||
|
font-size: 16px;
|
||||||
|
line-height: 1.7;
|
||||||
|
background-color: #FFF;
|
||||||
|
color: #343838;
|
||||||
|
}
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
font-family:'Inter', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||||
|
color: #222;
|
||||||
|
}
|
||||||
|
h1 small, h2 small, h3 small, h4 small, h5 small, h6 small, .h1 small, .h2 small, .h3 small, .h4 small, .h5 small, .h6 small, h1 .small, h2 .small, h3 .small, h4 .small, h5 .small, h6 .small, .h1 .small, .h2 .small, .h3 .small, .h4 .small, .h5 .small, .h6 .small {
|
||||||
|
color: #B1B7B9;
|
||||||
|
}
|
||||||
|
|
||||||
|
h2 {
|
||||||
|
margin-top: 35px;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2 {
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
h4 {
|
||||||
|
font-family: 'Inter', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||||
|
font-weight: 300;
|
||||||
|
margin-top: 20px;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
h5 {
|
||||||
|
font-family: 'Inter', 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||||
|
font-weight: 300;
|
||||||
|
font-variant: small-caps;
|
||||||
|
}
|
||||||
|
pre, code {
|
||||||
|
background-color: #FCFDFF;
|
||||||
|
}
|
||||||
|
pre>code {
|
||||||
|
font-size: 13px;
|
||||||
|
}
|
||||||
|
pre {
|
||||||
|
margin-top: 25px;
|
||||||
|
margin-bottom: 25px;
|
||||||
|
}
|
||||||
|
.lead {
|
||||||
|
font-family:"Inter", "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||||
|
font-weight: 400;
|
||||||
|
line-height: 1.4;
|
||||||
|
letter-spacing: 0.0312em;
|
||||||
|
color: #B1B7B9;
|
||||||
|
}
|
||||||
|
.navbar-default {
|
||||||
|
background-color: #343838;
|
||||||
|
border-bottom: 8px #EBF2F2 solid;
|
||||||
|
}
|
||||||
|
.bs-sidenav {
|
||||||
|
background-image: url("../img/grid11.png");
|
||||||
|
background-repeat: repeat;
|
||||||
|
font-family: Inter,"Helvetica Neue",Helvetica,Arial,sans-serif;
|
||||||
|
font-size: 13px;
|
||||||
|
}
|
||||||
|
.well {
|
||||||
|
background-color: #FCFDFF;
|
||||||
|
}
|
||||||
|
.btn-default {
|
||||||
|
background-color:#FCFDFF;
|
||||||
|
}
|
||||||
|
.table-striped > tbody > tr:nth-child(2n+1) > td, .table-striped > tbody > tr:nth-child(2n+1) > th {
|
||||||
|
background-color: #FCFDFF;
|
||||||
|
}
|
||||||
|
#mkdocs-search-query:focus {
|
||||||
|
outline: none;
|
||||||
|
-webkit-box-shadow: none;
|
||||||
|
box-shadow: none;
|
||||||
|
}
|
||||||
|
#mkdocs-search-query {
|
||||||
|
font-family:"Inter", "Helvetica Neue", Helvetica, Arial, sans-serif;
|
||||||
|
font-size: 20px;
|
||||||
|
font-weight: 700;
|
||||||
|
color: #343838;
|
||||||
|
height: 45px;
|
||||||
|
}
|
||||||
|
footer > hr {
|
||||||
|
width: 35%;
|
||||||
|
}
|
||||||
@ -0,0 +1 @@
|
|||||||
|
body{font-family:"Open Sans","Helvetica Neue",Helvetica,Arial,sans-serif;font-size:16px;line-height:1.7;background-color:#FFF;color:#343838}h1,h2,h3,h4,h5,h6{font-family:'Inter','Helvetica Neue',Helvetica,Arial,sans-serif;color:#222}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small,.h1 small,.h2 small,.h3 small,.h4 small,.h5 small,.h6 small,h1 .small,h2 .small,h3 .small,h4 .small,h5 .small,h6 .small,.h1 .small,.h2 .small,.h3 .small,.h4 .small,.h5 .small,.h6 .small{color:#b1b7b9}h2{margin-top:35px}h1,h2{font-weight:700}h4{font-family:'Inter','Helvetica Neue',Helvetica,Arial,sans-serif;font-weight:300;margin-top:20px;font-style:italic}h5{font-family:'Inter','Helvetica Neue',Helvetica,Arial,sans-serif;font-weight:300;font-variant:small-caps}pre,code{background-color:#fcfdff}pre>code{font-size:13px}pre{margin-top:25px;margin-bottom:25px}.lead{font-family:"Inter","Helvetica Neue",Helvetica,Arial,sans-serif;font-weight:400;line-height:1.4;letter-spacing:.0312em;color:#b1b7b9}.navbar-default{background-color:#343838;border-bottom:8px #ebf2f2 solid}.bs-sidenav{background-image:url("../img/grid11.png");background-repeat:repeat;font-family:Inter,"Helvetica Neue",Helvetica,Arial,sans-serif;font-size:13px}.well{background-color:#fcfdff}.btn-default{background-color:#fcfdff}.table-striped>tbody>tr:nth-child(2n+1)>td,.table-striped>tbody>tr:nth-child(2n+1)>th{background-color:#fcfdff}#mkdocs-search-query:focus{outline:0;-webkit-box-shadow:none;box-shadow:none}#mkdocs-search-query{font-family:"Inter","Helvetica Neue",Helvetica,Arial,sans-serif;font-size:20px;font-weight:700;color:#343838;height:45px}footer>hr{width:35%}
|
||||||
@ -0,0 +1,28 @@
|
|||||||
|
.navbar-default {
|
||||||
|
border-bottom: 0px;
|
||||||
|
background-color: #fff;
|
||||||
|
box-shadow: 0px 0px 15px rgba(0, 0, 0, 0.2);
|
||||||
|
}
|
||||||
|
|
||||||
|
a, .navbar-default a {
|
||||||
|
color: #06a !important;
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
.disabled > a {
|
||||||
|
color: #999 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar-default a:hover,
|
||||||
|
.navbar-default .active,
|
||||||
|
.active > a {
|
||||||
|
background-color: #f0f0f0 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.icon-bar {
|
||||||
|
background-color: #666 !important;
|
||||||
|
}
|
||||||
|
|
||||||
|
.navbar-collapse {
|
||||||
|
border-color: #fff !important;
|
||||||
|
}
|
||||||
@ -0,0 +1,99 @@
|
|||||||
|
/*
|
||||||
|
|
||||||
|
github.com style (c) Vasily Polovnyov <vast@whiteants.net>
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
.hljs {
|
||||||
|
display: block;
|
||||||
|
overflow-x: auto;
|
||||||
|
padding: 0.5em;
|
||||||
|
color: #333;
|
||||||
|
background: #FCFDFF;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-comment,
|
||||||
|
.hljs-quote {
|
||||||
|
color: #998;
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-keyword,
|
||||||
|
.hljs-selector-tag,
|
||||||
|
.hljs-subst {
|
||||||
|
color: #333;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-number,
|
||||||
|
.hljs-literal,
|
||||||
|
.hljs-variable,
|
||||||
|
.hljs-template-variable,
|
||||||
|
.hljs-tag .hljs-attr {
|
||||||
|
color: #008080;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-string,
|
||||||
|
.hljs-doctag {
|
||||||
|
color: #d14;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-title,
|
||||||
|
.hljs-section,
|
||||||
|
.hljs-selector-id {
|
||||||
|
color: #900;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-subst {
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-type,
|
||||||
|
.hljs-class .hljs-title {
|
||||||
|
color: #458;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-tag,
|
||||||
|
.hljs-name,
|
||||||
|
.hljs-attribute {
|
||||||
|
color: #000080;
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-regexp,
|
||||||
|
.hljs-link {
|
||||||
|
color: #009926;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-symbol,
|
||||||
|
.hljs-bullet {
|
||||||
|
color: #990073;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-built_in,
|
||||||
|
.hljs-builtin-name {
|
||||||
|
color: #0086b3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-meta {
|
||||||
|
color: #999;
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-deletion {
|
||||||
|
background: #fdd;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-addition {
|
||||||
|
background: #dfd;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-emphasis {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
.hljs-strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
@ -0,0 +1 @@
|
|||||||
|
.hljs{display:block;overflow-x:auto;padding:.5em;color:#333;background:#fcfdff}.hljs-comment,.hljs-quote{color:#998;font-style:italic}.hljs-keyword,.hljs-selector-tag,.hljs-subst{color:#333;font-weight:bold}.hljs-number,.hljs-literal,.hljs-variable,.hljs-template-variable,.hljs-tag .hljs-attr{color:teal}.hljs-string,.hljs-doctag{color:#d14}.hljs-title,.hljs-section,.hljs-selector-id{color:#900;font-weight:bold}.hljs-subst{font-weight:normal}.hljs-type,.hljs-class .hljs-title{color:#458;font-weight:bold}.hljs-tag,.hljs-name,.hljs-attribute{color:navy;font-weight:normal}.hljs-regexp,.hljs-link{color:#009926}.hljs-symbol,.hljs-bullet{color:#990073}.hljs-built_in,.hljs-builtin-name{color:#0086b3}.hljs-meta{color:#999;font-weight:bold}.hljs-deletion{background:#fdd}.hljs-addition{background:#dfd}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:bold}
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 197 KiB |
Binary file not shown.
Binary file not shown.
@ -0,0 +1,716 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
||||||
|
|
||||||
|
|
||||||
|
<title>Format - UnitCommitment.jl</title>
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/all.css">
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/v4-shims.css">
|
||||||
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
|
||||||
|
<link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
|
||||||
|
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
|
||||||
|
<link href="../css/bootstrap-custom.min.css" rel="stylesheet">
|
||||||
|
<link href="../css/base.min.css" rel="stylesheet">
|
||||||
|
<link href="../css/cinder.min.css" rel="stylesheet">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/styles/github.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link href="../css/custom.css" rel="stylesheet">
|
||||||
|
|
||||||
|
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/respond.js@1.4.2/dest/respond.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
||||||
|
<div class="container">
|
||||||
|
|
||||||
|
<!-- Collapsed navigation -->
|
||||||
|
<div class="navbar-header">
|
||||||
|
<!-- Expander button -->
|
||||||
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
|
||||||
|
<span class="sr-only">Toggle navigation</span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
</button>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Main title -->
|
||||||
|
|
||||||
|
|
||||||
|
<a class="navbar-brand" href="..">UnitCommitment.jl</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Expanded navigation -->
|
||||||
|
<div class="navbar-collapse collapse">
|
||||||
|
<!-- Main navigation -->
|
||||||
|
<ul class="nav navbar-nav">
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="..">Home</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../usage/">Usage</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="./">Format</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../instances/">Instances</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<ul class="nav navbar-nav navbar-right">
|
||||||
|
<li>
|
||||||
|
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
|
||||||
|
<i class="fas fa-search"></i> Search
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li >
|
||||||
|
<a rel="prev" href="../usage/">
|
||||||
|
<i class="fas fa-arrow-left"></i> Previous
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li >
|
||||||
|
<a rel="next" href="../instances/">
|
||||||
|
Next <i class="fas fa-arrow-right"></i>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="https://github.com/ANL-CEEESA/unitcommitment.jl/edit/dev/src/docs/format.md"><i class="fab fa-github"></i> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="container">
|
||||||
|
|
||||||
|
|
||||||
|
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
|
||||||
|
<ul class="nav bs-sidenav">
|
||||||
|
<li class="first-level active"><a href="#data-format">Data Format</a></li>
|
||||||
|
<li class="second-level"><a href="#1-input-data-format">1. Input Data Format</a></li>
|
||||||
|
|
||||||
|
<li class="third-level"><a href="#11-parameters">1.1 Parameters</a></li>
|
||||||
|
<li class="third-level"><a href="#12-buses">1.2 Buses</a></li>
|
||||||
|
<li class="third-level"><a href="#13-generators">1.3 Generators</a></li>
|
||||||
|
<li class="third-level"><a href="#14-price-sensitive-loads">1.4 Price-sensitive loads</a></li>
|
||||||
|
<li class="third-level"><a href="#15-transmission-lines">1.5 Transmission Lines</a></li>
|
||||||
|
<li class="third-level"><a href="#16-reserves">1.6 Reserves</a></li>
|
||||||
|
<li class="third-level"><a href="#17-contingencies">1.7 Contingencies</a></li>
|
||||||
|
<li class="third-level"><a href="#18-additional-remarks">1.8 Additional remarks</a></li>
|
||||||
|
<li class="second-level"><a href="#2-output-data-format">2. Output Data Format</a></li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div></div>
|
||||||
|
<div class="col-md-9" role="main">
|
||||||
|
|
||||||
|
<h1 id="data-format">Data Format</h1>
|
||||||
|
<h2 id="1-input-data-format">1. Input Data Format</h2>
|
||||||
|
<p>Instances are specified by JSON files containing the following main sections:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Parameters</li>
|
||||||
|
<li>Buses</li>
|
||||||
|
<li>Generators</li>
|
||||||
|
<li>Price-sensitive loads</li>
|
||||||
|
<li>Transmission lines</li>
|
||||||
|
<li>Reserves</li>
|
||||||
|
<li>Contingencies</li>
|
||||||
|
</ul>
|
||||||
|
<p>Each section is described in detail below. For a complete example, see <a href="https://github.com/ANL-CEEESA/UnitCommitment.jl/tree/dev/instances/matpower/case14">case14</a>.</p>
|
||||||
|
<h3 id="11-parameters">1.1 Parameters</h3>
|
||||||
|
<p>This section describes system-wide parameters, such as power balance penalties, optimization parameters, such as the length of the planning horizon and the time.</p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Key</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
<th align="center">Default</th>
|
||||||
|
<th align="center">Time series?</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Time horizon (h)</code></td>
|
||||||
|
<td align="left">Length of the planning horizon (in hours).</td>
|
||||||
|
<td align="center">Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Time step (min)</code></td>
|
||||||
|
<td align="left">Length of each time step (in minutes). Must be a divisor of 60 (e.g. 60, 30, 20, 15, etc).</td>
|
||||||
|
<td align="center"><code>60</code></td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Power balance penalty ($/MW)</code></td>
|
||||||
|
<td align="left">Penalty for system-wide shortage or surplus in production (in $/MW). This is charged per time step. For example, if there is a shortage of 1 MW for three time steps, three times this amount will be charged.</td>
|
||||||
|
<td align="center"><code>1000.0</code></td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="example">Example</h4>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"Parameters": {
|
||||||
|
"Time horizon (h)": 4,
|
||||||
|
"Power balance penalty ($/MW)": 1000.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="12-buses">1.2 Buses</h3>
|
||||||
|
<p>This section describes the characteristics of each bus in the system. </p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Key</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
<th>Default</th>
|
||||||
|
<th align="center">Time series?</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Load (MW)</code></td>
|
||||||
|
<td align="left">Fixed load connected to the bus (in MW).</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="example_1">Example</h4>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"Buses": {
|
||||||
|
"b1": {
|
||||||
|
"Load (MW)": 0.0
|
||||||
|
},
|
||||||
|
"b2": {
|
||||||
|
"Load (MW)": [
|
||||||
|
26.01527,
|
||||||
|
24.46212,
|
||||||
|
23.29725,
|
||||||
|
22.90897
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="13-generators">1.3 Generators</h3>
|
||||||
|
<p>This section describes all generators in the system, including thermal units, renewable units and virtual units.</p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Key</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
<th>Default</th>
|
||||||
|
<th align="center">Time series?</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Bus</code></td>
|
||||||
|
<td align="left">Identifier of the bus where this generator is located (string).</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Production cost curve (MW)</code> and <code>Production cost curve ($)</code></td>
|
||||||
|
<td align="left">Parameters describing the piecewise-linear production costs. See below for more details.</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Startup costs ($)</code> and <code>Startup delays (h)</code></td>
|
||||||
|
<td align="left">Parameters describing how much it costs to start the generator after it has been shut down for a certain amount of time. If <code>Startup costs ($)</code> and <code>Startup delays (h)</code> are set to <code>[300.0, 400.0]</code> and <code>[1, 4]</code>, for example, and the generator is shut down at time <code>00:00</code> (h:min), then it costs 300 to start up the generator at any time between <code>01:00</code> and <code>03:59</code>, and 400 to start the generator at time <code>04:00</code> or any time after that. The number of startup cost points is unlimited, and may be different for each generator. Startup delays must be strictly increasing and the first entry must equal <code>Minimum downtime (h)</code>.</td>
|
||||||
|
<td><code>[0.0]</code> and <code>[1]</code></td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Minimum uptime (h)</code></td>
|
||||||
|
<td align="left">Minimum amount of time the generator must stay operational after starting up (in hours). For example, if the generator starts up at time <code>00:00</code> (h:min) and <code>Minimum uptime (h)</code> is set to 4, then the generator can only shut down at time <code>04:00</code>.</td>
|
||||||
|
<td><code>1</code></td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Minimum downtime (h)</code></td>
|
||||||
|
<td align="left">Minimum amount of time the generator must stay offline after shutting down (in hours). For example, if the generator shuts down at time <code>00:00</code> (h:min) and <code>Minimum downtime (h)</code> is set to 4, then the generator can only start producing power again at time <code>04:00</code>.</td>
|
||||||
|
<td><code>1</code></td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Ramp up limit (MW)</code></td>
|
||||||
|
<td align="left">Maximum increase in production from one time step to the next (in MW). For example, if the generator is producing 100 MW at time step 1 and if this parameter is set to 40 MW, then the generator will produce at most 140 MW at time step 2.</td>
|
||||||
|
<td><code>+inf</code></td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Ramp down limit (MW)</code></td>
|
||||||
|
<td align="left">Maximum decrease in production from one time step to the next (in MW). For example, if the generator is producing 100 MW at time step 1 and this parameter is set to 40 MW, then the generator will produce at least 60 MW at time step 2.</td>
|
||||||
|
<td><code>+inf</code></td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Startup limit (MW)</code></td>
|
||||||
|
<td align="left">Maximum amount of power a generator can produce immediately after starting up (in MW). For example, if <code>Startup limit (MW)</code> is set to 100 MW and the unit is off at time step 1, then it may produce at most 100 MW at time step 2.</td>
|
||||||
|
<td><code>+inf</code></td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Shutdown limit (MW)</code></td>
|
||||||
|
<td align="left">Maximum amount of power a generator can produce immediately before shutting down (in MW). Specifically, the generator can only shut down at time step <code>t+1</code> if its production at time step <code>t</code> is below this limit.</td>
|
||||||
|
<td><code>+inf</code></td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Initial status (h)</code></td>
|
||||||
|
<td align="left">If set to a positive number, indicates the amount of time (in hours) the generator has been on at the beginning of the simulation, and if set to a negative number, the amount of time the generator has been off. For example, if <code>Initial status (h)</code> is <code>-2</code>, this means that the generator was off since <code>-02:00</code> (h:min). The simulation starts at time <code>00:00</code>. If <code>Initial status (h)</code> is <code>3</code>, this means that the generator was on since <code>-03:00</code>. A value of zero is not acceptable.</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Initial power (MW)</code></td>
|
||||||
|
<td align="left">Amount of power the generator at time step <code>-1</code>, immediately before the planning horizon starts.</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Must run?</code></td>
|
||||||
|
<td align="left">If <code>true</code>, the generator should be committed, even if that is not economical (Boolean).</td>
|
||||||
|
<td><code>false</code></td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Provides spinning reserves?</code></td>
|
||||||
|
<td align="left">If <code>true</code>, this generator may provide spinning reserves (Boolean).</td>
|
||||||
|
<td><code>true</code></td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="production-costs-and-limits">Production costs and limits</h4>
|
||||||
|
<p>Production costs are represented as piecewise-linear curves. Figure 1 shows an example cost curve with three segments, where it costs 1400, 1600, 2200 and 2400 dollars to generate, respectively, 100, 110, 130 and 135 MW of power. To model this generator, <code>Production cost curve (MW)</code> should be set to <code>[100, 110, 130, 135]</code>, and <code>Production cost curve ($)</code> should be set to <code>[1400, 1600, 2200, 2400]</code>.
|
||||||
|
Note that this curve also specifies the production limits. Specifically, the first point identifies the minimum power output when the unit is operational, while the last point identifies the maximum power output.</p>
|
||||||
|
<p><center>
|
||||||
|
<img src="../images/cost_curve.png" style="max-width: 500px"/>
|
||||||
|
<div><b>Figure 1.</b> Piecewise-linear production cost curve.</div>
|
||||||
|
<br/>
|
||||||
|
</center></p>
|
||||||
|
<h4 id="additional-remarks">Additional remarks:</h4>
|
||||||
|
<ul>
|
||||||
|
<li>For time-dependent production limits or time-dependent production costs, the usage of nested arrays is allowed. For example, if <code>Production cost curve (MW)</code> is set to <code>[5.0, [10.0, 12.0, 15.0, 20.0]]</code>, then the unit may generate at most 10, 12, 15 and 20 MW of power during time steps 1, 2, 3 and 4, respectively. The minimum output for all time periods is fixed to at 5 MW.</li>
|
||||||
|
<li>There is no limit to the number of piecewise-linear segments, and different generators may have a different number of segments.</li>
|
||||||
|
<li>If <code>Production cost curve (MW)</code> and <code>Production cost curve ($)</code> both contain a single element, then the generator must produce exactly that amount of power when operational. To specify that the generator may produce any amount of power up to a certain limit <code>P</code>, the parameter <code>Production cost curve (MW)</code> should be set to <code>[0, P]</code>. </li>
|
||||||
|
<li>Production cost curves must be convex.</li>
|
||||||
|
</ul>
|
||||||
|
<h4 id="example_2">Example</h4>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"Generators": {
|
||||||
|
"gen1": {
|
||||||
|
"Bus": "b1",
|
||||||
|
"Production cost curve (MW)": [100.0, 110.0, 130.0, 135.0],
|
||||||
|
"Production cost curve ($)": [1400.0, 1600.0, 2200.0, 2400.0],
|
||||||
|
"Startup costs ($)": [300.0, 400.0],
|
||||||
|
"Startup delays (h)": [1, 4],
|
||||||
|
"Ramp up limit (MW)": 232.68,
|
||||||
|
"Ramp down limit (MW)": 232.68,
|
||||||
|
"Startup limit (MW)": 232.68,
|
||||||
|
"Shutdown limit (MW)": 232.68,
|
||||||
|
"Minimum downtime (h)": 4,
|
||||||
|
"Minimum uptime (h)": 4,
|
||||||
|
"Initial status (h)": 12,
|
||||||
|
"Must run?": false,
|
||||||
|
"Provides spinning reserves?": true,
|
||||||
|
},
|
||||||
|
"gen2": {
|
||||||
|
"Bus": "b5",
|
||||||
|
"Production cost curve (MW)": [0.0, [10.0, 8.0, 0.0, 3.0]],
|
||||||
|
"Production cost curve ($)": [0.0, 0.0],
|
||||||
|
"Provides spinning reserves?": true,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="14-price-sensitive-loads">1.4 Price-sensitive loads</h3>
|
||||||
|
<p>This section describes components in the system which may increase or reduce their energy consumption according to the energy prices. Fixed loads (as described in the <code>buses</code> section) are always served, regardless of the price, unless there is significant congestion in the system or insufficient production capacity. Price-sensitive loads, on the other hand, are only served if it is economical to do so. </p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Key</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
<th align="center">Default</th>
|
||||||
|
<th align="center">Time series?</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Bus</code></td>
|
||||||
|
<td align="left">Bus where the load is located. Multiple price-sensitive loads may be placed at the same bus.</td>
|
||||||
|
<td align="center">Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Revenue ($/MW)</code></td>
|
||||||
|
<td align="left">Revenue obtained for serving each MW of power to this load.</td>
|
||||||
|
<td align="center">Required</td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Demand (MW)</code></td>
|
||||||
|
<td align="left">Maximum amount of power required by this load. Any amount lower than this may be served.</td>
|
||||||
|
<td align="center">Required</td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="example_3">Example</h4>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"Price-sensitive loads": {
|
||||||
|
"p1": {
|
||||||
|
"Bus": "b3",
|
||||||
|
"Revenue ($/MW)": 23.0,
|
||||||
|
"Demand (MW)": 50.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="15-transmission-lines">1.5 Transmission Lines</h3>
|
||||||
|
<p>This section describes the characteristics of transmission system, such as its topology and the susceptance of each transmission line.</p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Key</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
<th>Default</th>
|
||||||
|
<th align="center">Time series?</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Source bus</code></td>
|
||||||
|
<td align="left">Identifier of the bus where the transmission line originates.</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Target bus</code></td>
|
||||||
|
<td align="left">Identifier of the bus where the transmission line reaches.</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Reactance (ohms)</code></td>
|
||||||
|
<td align="left">Reactance of the transmission line (in ohms).</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Susceptance (S)</code></td>
|
||||||
|
<td align="left">Susceptance of the transmission line (in siemens).</td>
|
||||||
|
<td>Required</td>
|
||||||
|
<td align="center">N</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Normal flow limit (MW)</code></td>
|
||||||
|
<td align="left">Maximum amount of power (in MW) allowed to flow through the line when the system is in its regular, fully-operational state.</td>
|
||||||
|
<td><code>+inf</code></td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Emergency flow limit (MW)</code></td>
|
||||||
|
<td align="left">Maximum amount of power (in MW) allowed to flow through the line when the system is in degraded state (for example, after the failure of another transmission line).</td>
|
||||||
|
<td><code>+inf</code></td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Flow limit penalty ($/MW)</code></td>
|
||||||
|
<td align="left">Penalty for violating the flow limits of the transmission line (in $/MW). This is charged per time step. For example, if there is a thermal violation of 1 MW for three time steps, then three times this amount will be charged.</td>
|
||||||
|
<td><code>5000.0</code></td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="example_4">Example</h4>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"Transmission lines": {
|
||||||
|
"l1": {
|
||||||
|
"Source bus": "b1",
|
||||||
|
"Target bus": "b2",
|
||||||
|
"Reactance (ohms)": 0.05917,
|
||||||
|
"Susceptance (S)": 29.49686,
|
||||||
|
"Normal flow limit (MW)": 15000.0,
|
||||||
|
"Emergency flow limit (MW)": 20000.0,
|
||||||
|
"Flow limit penalty ($/MW)": 5000.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="16-reserves">1.6 Reserves</h3>
|
||||||
|
<p>This section describes the hourly amount of operating reserves required.</p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Key</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
<th>Default</th>
|
||||||
|
<th align="center">Time series?</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Spinning (MW)</code></td>
|
||||||
|
<td align="left">Minimum amount of system-wide spinning reserves (in MW). Only generators which are online may provide this reserve.</td>
|
||||||
|
<td><code>0.0</code></td>
|
||||||
|
<td align="center">Y</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="example_5">Example</h4>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"Reserves": {
|
||||||
|
"Spinning (MW)": [
|
||||||
|
57.30552,
|
||||||
|
53.88429,
|
||||||
|
51.31838,
|
||||||
|
50.46307
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="17-contingencies">1.7 Contingencies</h3>
|
||||||
|
<p>This section describes credible contingency scenarios in the optimization, such as the loss of a transmission line or generator.</p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th align="left">Key</th>
|
||||||
|
<th align="left">Description</th>
|
||||||
|
<th>Default</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Affected generators</code></td>
|
||||||
|
<td align="left">List of generators affected by this contingency. May be omitted if no generators are affected.</td>
|
||||||
|
<td><code>[]</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="left"><code>Affected lines</code></td>
|
||||||
|
<td align="left">List of transmission lines affected by this contingency. May be omitted if no lines are affected.</td>
|
||||||
|
<td><code>[]</code></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="example_6">Example</h4>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"Contingencies": {
|
||||||
|
"c1": {
|
||||||
|
"Affected lines": ["l1", "l2", "l3"],
|
||||||
|
"Affected generators": ["g1"]
|
||||||
|
},
|
||||||
|
"c2": {
|
||||||
|
"Affected lines": ["l4"]
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="18-additional-remarks">1.8 Additional remarks</h3>
|
||||||
|
<h4 id="time-series-parameters">Time series parameters</h4>
|
||||||
|
<p>Many numerical properties in the JSON file can be specified either as a single floating point number if they are time-independent, or as an array containing exactly <code>T</code> elements, if they are time-dependent, where <code>T</code> is the number of time steps in the planning horizon. For example, both formats below are valid when <code>T=3</code>:</p>
|
||||||
|
<pre><code class="language-json">{
|
||||||
|
"Load (MW)": 800.0,
|
||||||
|
"Load (MW)": [800.0, 850.0, 730.0]
|
||||||
|
}
|
||||||
|
</code></pre>
|
||||||
|
<p>The value <code>T</code> depends on both <code>Time horizon (h)</code> and <code>Time step (min)</code>, as the table below illustrates.</p>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Time horizon (h)</th>
|
||||||
|
<th>Time step (min)</th>
|
||||||
|
<th>T</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>24</td>
|
||||||
|
<td>60</td>
|
||||||
|
<td>24</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>24</td>
|
||||||
|
<td>15</td>
|
||||||
|
<td>96</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>24</td>
|
||||||
|
<td>5</td>
|
||||||
|
<td>288</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>36</td>
|
||||||
|
<td>60</td>
|
||||||
|
<td>36</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>36</td>
|
||||||
|
<td>15</td>
|
||||||
|
<td>144</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>36</td>
|
||||||
|
<td>5</td>
|
||||||
|
<td>432</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h4 id="current-limitations">Current limitations</h4>
|
||||||
|
<ul>
|
||||||
|
<li>All reserves are system-wide (no zonal reserves)</li>
|
||||||
|
<li>Network topology remains the same for all time periods</li>
|
||||||
|
<li>Only N-1 transmission contingencies are supported. Generator contingencies are not supported.</li>
|
||||||
|
<li>Time-varying minimum production amounts are not currently compatible with ramp/startup/shutdown limits.</li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="2-output-data-format">2. Output Data Format</h2>
|
||||||
|
<p>The output data format is also JSON-based, but it is not currently documented since we expect it to change significantly in a future version of the package.</p></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer class="col-md-12 text-center">
|
||||||
|
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
<p>
|
||||||
|
<small>Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved.</small><br>
|
||||||
|
|
||||||
|
<small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
|
||||||
|
<script src="../js/bootstrap-3.0.3.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js"></script>
|
||||||
|
|
||||||
|
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/languages/julia.min.js"></script>
|
||||||
|
|
||||||
|
<script>hljs.initHighlightingOnLoad();</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var base_url = ".."</script>
|
||||||
|
|
||||||
|
<script src="../js/base.js"></script>
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||||
|
<script src="../js/mathjax.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
|
||||||
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-dialog modal-lg">
|
||||||
|
<div class="modal-content">
|
||||||
|
<div class="modal-header">
|
||||||
|
<button type="button" class="close" data-dismiss="modal">
|
||||||
|
<span aria-hidden="true">×</span>
|
||||||
|
<span class="sr-only">Close</span>
|
||||||
|
</button>
|
||||||
|
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<p>
|
||||||
|
From here you can search these documents. Enter
|
||||||
|
your search terms below.
|
||||||
|
</p>
|
||||||
|
<form>
|
||||||
|
<div class="form-group">
|
||||||
|
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
<div id="mkdocs-search-results"></div>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-dialog">
|
||||||
|
<div class="modal-content">
|
||||||
|
<div class="modal-header">
|
||||||
|
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
||||||
|
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<table class="table">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th style="width: 20%;">Keys</th>
|
||||||
|
<th>Action</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td class="help shortcut"><kbd>?</kbd></td>
|
||||||
|
<td>Open this help</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="next shortcut"><kbd>n</kbd></td>
|
||||||
|
<td>Next page</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="prev shortcut"><kbd>p</kbd></td>
|
||||||
|
<td>Previous page</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="search shortcut"><kbd>s</kbd></td>
|
||||||
|
<td>Search</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
|
After Width: | Height: | Size: 35 KiB |
|
After Width: | Height: | Size: 1.1 KiB |
|
After Width: | Height: | Size: 251 B |
|
After Width: | Height: | Size: 495 B |
|
After Width: | Height: | Size: 253 B |
|
After Width: | Height: | Size: 260 B |
|
After Width: | Height: | Size: 266 B |
|
After Width: | Height: | Size: 240 B |
|
After Width: | Height: | Size: 442 B |
|
After Width: | Height: | Size: 442 B |
|
After Width: | Height: | Size: 442 B |
|
After Width: | Height: | Size: 457 B |
|
After Width: | Height: | Size: 427 B |
|
After Width: | Height: | Size: 271 B |
|
After Width: | Height: | Size: 493 B |
|
After Width: | Height: | Size: 266 B |
|
After Width: | Height: | Size: 244 B |
|
After Width: | Height: | Size: 442 B |
|
After Width: | Height: | Size: 460 B |
|
After Width: | Height: | Size: 442 B |
|
After Width: | Height: | Size: 457 B |
|
After Width: | Height: | Size: 456 B |
@ -0,0 +1,298 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="shortcut icon" href="img/favicon.ico">
|
||||||
|
|
||||||
|
|
||||||
|
<title>Home - UnitCommitment.jl</title>
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/all.css">
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/v4-shims.css">
|
||||||
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
|
||||||
|
<link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
|
||||||
|
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
|
||||||
|
<link href="css/bootstrap-custom.min.css" rel="stylesheet">
|
||||||
|
<link href="css/base.min.css" rel="stylesheet">
|
||||||
|
<link href="css/cinder.min.css" rel="stylesheet">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/styles/github.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link href="css/custom.css" rel="stylesheet">
|
||||||
|
|
||||||
|
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/respond.js@1.4.2/dest/respond.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body class="homepage" >
|
||||||
|
|
||||||
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
||||||
|
<div class="container">
|
||||||
|
|
||||||
|
<!-- Collapsed navigation -->
|
||||||
|
<div class="navbar-header">
|
||||||
|
<!-- Expander button -->
|
||||||
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
|
||||||
|
<span class="sr-only">Toggle navigation</span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
</button>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Main title -->
|
||||||
|
|
||||||
|
|
||||||
|
<a class="navbar-brand" href=".">UnitCommitment.jl</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Expanded navigation -->
|
||||||
|
<div class="navbar-collapse collapse">
|
||||||
|
<!-- Main navigation -->
|
||||||
|
<ul class="nav navbar-nav">
|
||||||
|
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href=".">Home</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="usage/">Usage</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="format/">Format</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="instances/">Instances</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<ul class="nav navbar-nav navbar-right">
|
||||||
|
<li>
|
||||||
|
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
|
||||||
|
<i class="fas fa-search"></i> Search
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li class="disabled">
|
||||||
|
<a rel="prev" >
|
||||||
|
<i class="fas fa-arrow-left"></i> Previous
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li >
|
||||||
|
<a rel="next" href="usage/">
|
||||||
|
Next <i class="fas fa-arrow-right"></i>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="https://github.com/ANL-CEEESA/unitcommitment.jl/edit/dev/src/docs/index.md"><i class="fab fa-github"></i> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="container">
|
||||||
|
|
||||||
|
|
||||||
|
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
|
||||||
|
<ul class="nav bs-sidenav">
|
||||||
|
<li class="first-level active"><a href="#unitcommitmentjl">UnitCommitment.jl</a></li>
|
||||||
|
<li class="second-level"><a href="#package-components">Package Components</a></li>
|
||||||
|
|
||||||
|
<li class="second-level"><a href="#documentation">Documentation</a></li>
|
||||||
|
|
||||||
|
<li class="second-level"><a href="#source-code">Source code</a></li>
|
||||||
|
|
||||||
|
<li class="second-level"><a href="#authors">Authors</a></li>
|
||||||
|
|
||||||
|
<li class="second-level"><a href="#acknowledgments">Acknowledgments</a></li>
|
||||||
|
|
||||||
|
<li class="second-level"><a href="#citing">Citing</a></li>
|
||||||
|
|
||||||
|
<li class="second-level"><a href="#license">License</a></li>
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
</div></div>
|
||||||
|
<div class="col-md-9" role="main">
|
||||||
|
|
||||||
|
<h1 id="unitcommitmentjl">UnitCommitment.jl</h1>
|
||||||
|
<p><strong>UnitCommitment.jl</strong> (UC.jl) is a Julia optimization package for the Security-Constrained Unit Commitment Problem (SCUC), a fundamental optimization problem in power systems used, for example, to clear the day-ahead electricity markets. The package provides benchmark instances for the problem and Julia/JuMP implementations of state-of-the-art mixed-integer programming formulations.</p>
|
||||||
|
<h3 id="package-components">Package Components</h3>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Data Format:</strong> The package proposes an extensible and fully-documented JSON-based data specification format for SCUC, developed in collaboration with Independent System Operators (ISOs), which describes the most important aspects of the problem. The format supports all the most common generator characteristics (including ramping, piecewise-linear production cost curves and time-dependent startup costs), as well as operating reserves, price-sensitive loads, transmission networks and contingencies.</li>
|
||||||
|
<li><strong>Benchmark Instances:</strong> The package provides a diverse collection of large-scale benchmark instances collected from the literature and extended to make them more challenging and realistic.</li>
|
||||||
|
<li><strong>Model Implementation</strong>: The package provides a Julia/JuMP implementation of state-of-the-art formulations and solution methods for SCUC. Our goal is to keep this implementation up-to-date, as new methods are proposed in the literature.</li>
|
||||||
|
<li><strong>Benchmark Tools:</strong> The package provides automated benchmark scripts to accurately evaluate the performance impact of proposed code changes.</li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="documentation">Documentation</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="usage/">Usage</a></li>
|
||||||
|
<li><a href="format/">Data Format</a></li>
|
||||||
|
<li><a href="instances/">Instances</a></li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="source-code">Source code</h3>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://github.com/ANL-CEEESA/unitcommitment.jl">https://github.com/ANL-CEEESA/unitcommitment.jl</a></li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="authors">Authors</h3>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Alinson Santos Xavier</strong> (Argonne National Laboratory)</li>
|
||||||
|
<li><strong>Feng Qiu</strong> (Argonne National Laboratory)</li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="acknowledgments">Acknowledgments</h3>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<p>We would like to thank <strong>Aleksandr M. Kazachkov</strong> (University of Florida), <strong>Yonghong Chen</strong> (Midcontinent Independent System Operator), <strong>Feng Pan</strong> (Pacific Northwest National Laboratory) for valuable feedback on early versions of this package.</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>Based upon work supported by <strong>Laboratory Directed Research and Development</strong> (LDRD) funding from Argonne National Laboratory, provided by the Director, Office of Science, of the U.S. Department of Energy under Contract No. DE-AC02-06CH11357.</p>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<h3 id="citing">Citing</h3>
|
||||||
|
<p>If you use UnitCommitment.jl in your research, we request that you cite the package as follows:</p>
|
||||||
|
<ul>
|
||||||
|
<li>Alinson S. Xavier, Feng Qiu, "UnitCommitment.jl: A Julia/JuMP Optimization Package for Security-Constrained Unit Commitment". Zenodo (2020). <a href="https://doi.org/10.5281/zenodo.4269874">DOI: 10.5281/zenodo.4269874</a>.</li>
|
||||||
|
</ul>
|
||||||
|
<p>If you make use of the provided instances files, we request that you additionally cite the original sources, as described in the <a href="instances/">instances page</a>.</p>
|
||||||
|
<h3 id="license">License</h3>
|
||||||
|
<p>Released under the modified BSD license. See <code>LICENSE.md</code> for more details.</p></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer class="col-md-12 text-center">
|
||||||
|
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
<p>
|
||||||
|
<small>Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved.</small><br>
|
||||||
|
|
||||||
|
<small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
|
||||||
|
<script src="js/bootstrap-3.0.3.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js"></script>
|
||||||
|
|
||||||
|
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/languages/julia.min.js"></script>
|
||||||
|
|
||||||
|
<script>hljs.initHighlightingOnLoad();</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var base_url = "."</script>
|
||||||
|
|
||||||
|
<script src="js/base.js"></script>
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||||
|
<script src="js/mathjax.js"></script>
|
||||||
|
<script src="search/main.js"></script>
|
||||||
|
|
||||||
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-dialog modal-lg">
|
||||||
|
<div class="modal-content">
|
||||||
|
<div class="modal-header">
|
||||||
|
<button type="button" class="close" data-dismiss="modal">
|
||||||
|
<span aria-hidden="true">×</span>
|
||||||
|
<span class="sr-only">Close</span>
|
||||||
|
</button>
|
||||||
|
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<p>
|
||||||
|
From here you can search these documents. Enter
|
||||||
|
your search terms below.
|
||||||
|
</p>
|
||||||
|
<form>
|
||||||
|
<div class="form-group">
|
||||||
|
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
<div id="mkdocs-search-results"></div>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-dialog">
|
||||||
|
<div class="modal-content">
|
||||||
|
<div class="modal-header">
|
||||||
|
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
||||||
|
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<table class="table">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th style="width: 20%;">Keys</th>
|
||||||
|
<th>Action</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td class="help shortcut"><kbd>?</kbd></td>
|
||||||
|
<td>Open this help</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="next shortcut"><kbd>n</kbd></td>
|
||||||
|
<td>Next page</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="prev shortcut"><kbd>p</kbd></td>
|
||||||
|
<td>Previous page</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="search shortcut"><kbd>s</kbd></td>
|
||||||
|
<td>Search</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
|
|
||||||
|
<!--
|
||||||
|
MkDocs version : 1.1.2
|
||||||
|
Build Date UTC : 2021-03-09 17:08:39.922653+00:00
|
||||||
|
-->
|
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,225 @@
|
|||||||
|
function getSearchTerm() {
|
||||||
|
var sPageURL = window.location.search.substring(1);
|
||||||
|
var sURLVariables = sPageURL.split('&');
|
||||||
|
for (var i = 0; i < sURLVariables.length; i++) {
|
||||||
|
var sParameterName = sURLVariables[i].split('=');
|
||||||
|
if (sParameterName[0] == 'q') {
|
||||||
|
return sParameterName[1];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$(document).ready(function() {
|
||||||
|
/**
|
||||||
|
* ------------------------------------------------------------------------
|
||||||
|
* Taken from themes/mkdocs/js/base.js
|
||||||
|
* ------------------------------------------------------------------------
|
||||||
|
*/
|
||||||
|
var search_term = getSearchTerm(),
|
||||||
|
$search_modal = $('#mkdocs_search_modal'),
|
||||||
|
$keyboard_modal = $('#mkdocs_keyboard_modal');
|
||||||
|
|
||||||
|
if (search_term) {
|
||||||
|
$search_modal.modal();
|
||||||
|
}
|
||||||
|
|
||||||
|
// make sure search input gets autofocus everytime modal opens.
|
||||||
|
$search_modal.on('shown.bs.modal', function() {
|
||||||
|
$search_modal.find('#mkdocs-search-query').focus();
|
||||||
|
});
|
||||||
|
|
||||||
|
// Close search modal when result is selected
|
||||||
|
// The links get added later so listen to parent
|
||||||
|
$('#mkdocs-search-results').click(function(e) {
|
||||||
|
if ($(e.target).is('a')) {
|
||||||
|
$search_modal.modal('hide');
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
if (typeof shortcuts !== 'undefined') {
|
||||||
|
// Populate keyboard modal with proper Keys
|
||||||
|
$keyboard_modal.find('.help.shortcut kbd')[0].innerHTML = keyCodes[shortcuts.help];
|
||||||
|
$keyboard_modal.find('.prev.shortcut kbd')[0].innerHTML = keyCodes[shortcuts.previous];
|
||||||
|
$keyboard_modal.find('.next.shortcut kbd')[0].innerHTML = keyCodes[shortcuts.next];
|
||||||
|
$keyboard_modal.find('.search.shortcut kbd')[0].innerHTML = keyCodes[shortcuts.search];
|
||||||
|
|
||||||
|
// Keyboard navigation
|
||||||
|
document.addEventListener("keydown", function(e) {
|
||||||
|
if ($(e.target).is(':input')) return true;
|
||||||
|
var key = e.which || e.key || window.event && window.event.key;
|
||||||
|
var page;
|
||||||
|
switch (key) {
|
||||||
|
case shortcuts.next:
|
||||||
|
page = $('.navbar a[rel="next"]:first').prop('href');
|
||||||
|
break;
|
||||||
|
case shortcuts.previous:
|
||||||
|
page = $('.navbar a[rel="prev"]:first').prop('href');
|
||||||
|
break;
|
||||||
|
case shortcuts.search:
|
||||||
|
e.preventDefault();
|
||||||
|
$keyboard_modal.modal('hide');
|
||||||
|
$search_modal.modal('show');
|
||||||
|
$search_modal.find('#mkdocs-search-query').focus();
|
||||||
|
break;
|
||||||
|
case shortcuts.help:
|
||||||
|
$search_modal.modal('hide');
|
||||||
|
$keyboard_modal.modal('show');
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
if (page) {
|
||||||
|
$keyboard_modal.modal('hide');
|
||||||
|
window.location.href = page;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
$('table').addClass('table table-striped table-hover');
|
||||||
|
|
||||||
|
// Improve the scrollspy behaviour when users click on a TOC item.
|
||||||
|
$(".bs-sidenav a").on("click", function() {
|
||||||
|
var clicked = this;
|
||||||
|
setTimeout(function() {
|
||||||
|
var active = $('.nav li.active a');
|
||||||
|
active = active[active.length - 1];
|
||||||
|
if (clicked !== active) {
|
||||||
|
$(active).parent().removeClass("active");
|
||||||
|
$(clicked).parent().addClass("active");
|
||||||
|
}
|
||||||
|
}, 50);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ------------------------------------------------------------------------
|
||||||
|
* Taken from themes/mkdocs/js/base.js
|
||||||
|
* ------------------------------------------------------------------------
|
||||||
|
*/
|
||||||
|
|
||||||
|
$('body').scrollspy({
|
||||||
|
target: '.bs-sidebar',
|
||||||
|
offset: 100
|
||||||
|
});
|
||||||
|
|
||||||
|
/* Prevent disabled links from causing a page reload */
|
||||||
|
$("li.disabled a").click(function() {
|
||||||
|
event.preventDefault();
|
||||||
|
});
|
||||||
|
|
||||||
|
// See https://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes
|
||||||
|
// We only list common keys below. Obscure keys are omited and their use is discouraged.
|
||||||
|
var keyCodes = {
|
||||||
|
8: 'backspace',
|
||||||
|
9: 'tab',
|
||||||
|
13: 'enter',
|
||||||
|
16: 'shift',
|
||||||
|
17: 'ctrl',
|
||||||
|
18: 'alt',
|
||||||
|
19: 'pause/break',
|
||||||
|
20: 'caps lock',
|
||||||
|
27: 'escape',
|
||||||
|
32: 'spacebar',
|
||||||
|
33: 'page up',
|
||||||
|
34: 'page down',
|
||||||
|
35: 'end',
|
||||||
|
36: 'home',
|
||||||
|
37: '←',
|
||||||
|
38: '↑',
|
||||||
|
39: '→',
|
||||||
|
40: '↓',
|
||||||
|
45: 'insert',
|
||||||
|
46: 'delete',
|
||||||
|
48: '0',
|
||||||
|
49: '1',
|
||||||
|
50: '2',
|
||||||
|
51: '3',
|
||||||
|
52: '4',
|
||||||
|
53: '5',
|
||||||
|
54: '6',
|
||||||
|
55: '7',
|
||||||
|
56: '8',
|
||||||
|
57: '9',
|
||||||
|
65: 'a',
|
||||||
|
66: 'b',
|
||||||
|
67: 'c',
|
||||||
|
68: 'd',
|
||||||
|
69: 'e',
|
||||||
|
70: 'f',
|
||||||
|
71: 'g',
|
||||||
|
72: 'h',
|
||||||
|
73: 'i',
|
||||||
|
74: 'j',
|
||||||
|
75: 'k',
|
||||||
|
76: 'l',
|
||||||
|
77: 'm',
|
||||||
|
78: 'n',
|
||||||
|
79: 'o',
|
||||||
|
80: 'p',
|
||||||
|
81: 'q',
|
||||||
|
82: 'r',
|
||||||
|
83: 's',
|
||||||
|
84: 't',
|
||||||
|
85: 'u',
|
||||||
|
86: 'v',
|
||||||
|
87: 'w',
|
||||||
|
88: 'x',
|
||||||
|
89: 'y',
|
||||||
|
90: 'z',
|
||||||
|
91: 'Left Windows Key / Left ⌘',
|
||||||
|
92: 'Right Windows Key',
|
||||||
|
93: 'Windows Menu / Right ⌘',
|
||||||
|
96: 'numpad 0',
|
||||||
|
97: 'numpad 1',
|
||||||
|
98: 'numpad 2',
|
||||||
|
99: 'numpad 3',
|
||||||
|
100: 'numpad 4',
|
||||||
|
101: 'numpad 5',
|
||||||
|
102: 'numpad 6',
|
||||||
|
103: 'numpad 7',
|
||||||
|
104: 'numpad 8',
|
||||||
|
105: 'numpad 9',
|
||||||
|
106: 'multiply',
|
||||||
|
107: 'add',
|
||||||
|
109: 'subtract',
|
||||||
|
110: 'decimal point',
|
||||||
|
111: 'divide',
|
||||||
|
112: 'f1',
|
||||||
|
113: 'f2',
|
||||||
|
114: 'f3',
|
||||||
|
115: 'f4',
|
||||||
|
116: 'f5',
|
||||||
|
117: 'f6',
|
||||||
|
118: 'f7',
|
||||||
|
119: 'f8',
|
||||||
|
120: 'f9',
|
||||||
|
121: 'f10',
|
||||||
|
122: 'f11',
|
||||||
|
123: 'f12',
|
||||||
|
124: 'f13',
|
||||||
|
125: 'f14',
|
||||||
|
126: 'f15',
|
||||||
|
127: 'f16',
|
||||||
|
128: 'f17',
|
||||||
|
129: 'f18',
|
||||||
|
130: 'f19',
|
||||||
|
131: 'f20',
|
||||||
|
132: 'f21',
|
||||||
|
133: 'f22',
|
||||||
|
134: 'f23',
|
||||||
|
135: 'f24',
|
||||||
|
144: 'num lock',
|
||||||
|
145: 'scroll lock',
|
||||||
|
186: ';',
|
||||||
|
187: '=',
|
||||||
|
188: ',',
|
||||||
|
189: '‐',
|
||||||
|
190: '.',
|
||||||
|
191: '?',
|
||||||
|
192: '`',
|
||||||
|
219: '[',
|
||||||
|
220: '\',
|
||||||
|
221: ']',
|
||||||
|
222: ''',
|
||||||
|
};
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@ -0,0 +1,8 @@
|
|||||||
|
MathJax.Hub.Config({
|
||||||
|
"tex2jax": { inlineMath: [ [ '$', '$' ] ] }
|
||||||
|
});
|
||||||
|
MathJax.Hub.Config({
|
||||||
|
config: ["MMLorHTML.js"],
|
||||||
|
jax: ["input/TeX", "output/HTML-CSS", "output/NativeMML"],
|
||||||
|
extensions: ["MathMenu.js", "MathZoom.js"]
|
||||||
|
});
|
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,98 @@
|
|||||||
|
function getSearchTermFromLocation() {
|
||||||
|
var sPageURL = window.location.search.substring(1);
|
||||||
|
var sURLVariables = sPageURL.split('&');
|
||||||
|
for (var i = 0; i < sURLVariables.length; i++) {
|
||||||
|
var sParameterName = sURLVariables[i].split('=');
|
||||||
|
if (sParameterName[0] == 'q') {
|
||||||
|
return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function joinUrl (base, path) {
|
||||||
|
if (path.substring(0, 1) === "/") {
|
||||||
|
// path starts with `/`. Thus it is absolute.
|
||||||
|
return path;
|
||||||
|
}
|
||||||
|
if (base.substring(base.length-1) === "/") {
|
||||||
|
// base ends with `/`
|
||||||
|
return base + path;
|
||||||
|
}
|
||||||
|
return base + "/" + path;
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatResult (location, title, summary) {
|
||||||
|
return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ title + '</a></h3><p>' + summary +'</p></article>';
|
||||||
|
}
|
||||||
|
|
||||||
|
function displayResults (results) {
|
||||||
|
var search_results = document.getElementById("mkdocs-search-results");
|
||||||
|
while (search_results.firstChild) {
|
||||||
|
search_results.removeChild(search_results.firstChild);
|
||||||
|
}
|
||||||
|
if (results.length > 0){
|
||||||
|
for (var i=0; i < results.length; i++){
|
||||||
|
var result = results[i];
|
||||||
|
var html = formatResult(result.location, result.title, result.summary);
|
||||||
|
search_results.insertAdjacentHTML('beforeend', html);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
search_results.insertAdjacentHTML('beforeend', "<p>No results found</p>");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function doSearch () {
|
||||||
|
var query = document.getElementById('mkdocs-search-query').value;
|
||||||
|
if (query.length > min_search_length) {
|
||||||
|
if (!window.Worker) {
|
||||||
|
displayResults(search(query));
|
||||||
|
} else {
|
||||||
|
searchWorker.postMessage({query: query});
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// Clear results for short queries
|
||||||
|
displayResults([]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function initSearch () {
|
||||||
|
var search_input = document.getElementById('mkdocs-search-query');
|
||||||
|
if (search_input) {
|
||||||
|
search_input.addEventListener("keyup", doSearch);
|
||||||
|
}
|
||||||
|
var term = getSearchTermFromLocation();
|
||||||
|
if (term) {
|
||||||
|
search_input.value = term;
|
||||||
|
doSearch();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWorkerMessage (e) {
|
||||||
|
if (e.data.allowSearch) {
|
||||||
|
initSearch();
|
||||||
|
} else if (e.data.results) {
|
||||||
|
var results = e.data.results;
|
||||||
|
displayResults(results);
|
||||||
|
} else if (e.data.config) {
|
||||||
|
min_search_length = e.data.config.min_search_length-1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!window.Worker) {
|
||||||
|
console.log('Web Worker API not supported');
|
||||||
|
// load index in main thread
|
||||||
|
$.getScript(joinUrl(base_url, "search/worker.js")).done(function () {
|
||||||
|
console.log('Loaded worker');
|
||||||
|
init();
|
||||||
|
window.postMessage = function (msg) {
|
||||||
|
onWorkerMessage({data: msg});
|
||||||
|
};
|
||||||
|
}).fail(function (jqxhr, settings, exception) {
|
||||||
|
console.error('Could not load worker.js');
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
// Wrap search in a web worker
|
||||||
|
var searchWorker = new Worker(joinUrl(base_url, "search/worker.js"));
|
||||||
|
searchWorker.postMessage({init: true});
|
||||||
|
searchWorker.onmessage = onWorkerMessage;
|
||||||
|
}
|
||||||
File diff suppressed because one or more lines are too long
@ -0,0 +1,130 @@
|
|||||||
|
var base_path = 'function' === typeof importScripts ? '.' : '/search/';
|
||||||
|
var allowSearch = false;
|
||||||
|
var index;
|
||||||
|
var documents = {};
|
||||||
|
var lang = ['en'];
|
||||||
|
var data;
|
||||||
|
|
||||||
|
function getScript(script, callback) {
|
||||||
|
console.log('Loading script: ' + script);
|
||||||
|
$.getScript(base_path + script).done(function () {
|
||||||
|
callback();
|
||||||
|
}).fail(function (jqxhr, settings, exception) {
|
||||||
|
console.log('Error: ' + exception);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function getScriptsInOrder(scripts, callback) {
|
||||||
|
if (scripts.length === 0) {
|
||||||
|
callback();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
getScript(scripts[0], function() {
|
||||||
|
getScriptsInOrder(scripts.slice(1), callback);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadScripts(urls, callback) {
|
||||||
|
if( 'function' === typeof importScripts ) {
|
||||||
|
importScripts.apply(null, urls);
|
||||||
|
callback();
|
||||||
|
} else {
|
||||||
|
getScriptsInOrder(urls, callback);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function onJSONLoaded () {
|
||||||
|
data = JSON.parse(this.responseText);
|
||||||
|
var scriptsToLoad = ['lunr.js'];
|
||||||
|
if (data.config && data.config.lang && data.config.lang.length) {
|
||||||
|
lang = data.config.lang;
|
||||||
|
}
|
||||||
|
if (lang.length > 1 || lang[0] !== "en") {
|
||||||
|
scriptsToLoad.push('lunr.stemmer.support.js');
|
||||||
|
if (lang.length > 1) {
|
||||||
|
scriptsToLoad.push('lunr.multi.js');
|
||||||
|
}
|
||||||
|
for (var i=0; i < lang.length; i++) {
|
||||||
|
if (lang[i] != 'en') {
|
||||||
|
scriptsToLoad.push(['lunr', lang[i], 'js'].join('.'));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
loadScripts(scriptsToLoad, onScriptsLoaded);
|
||||||
|
}
|
||||||
|
|
||||||
|
function onScriptsLoaded () {
|
||||||
|
console.log('All search scripts loaded, building Lunr index...');
|
||||||
|
if (data.config && data.config.separator && data.config.separator.length) {
|
||||||
|
lunr.tokenizer.separator = new RegExp(data.config.separator);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (data.index) {
|
||||||
|
index = lunr.Index.load(data.index);
|
||||||
|
data.docs.forEach(function (doc) {
|
||||||
|
documents[doc.location] = doc;
|
||||||
|
});
|
||||||
|
console.log('Lunr pre-built index loaded, search ready');
|
||||||
|
} else {
|
||||||
|
index = lunr(function () {
|
||||||
|
if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) {
|
||||||
|
this.use(lunr[lang[0]]);
|
||||||
|
} else if (lang.length > 1) {
|
||||||
|
this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility
|
||||||
|
}
|
||||||
|
this.field('title');
|
||||||
|
this.field('text');
|
||||||
|
this.ref('location');
|
||||||
|
|
||||||
|
for (var i=0; i < data.docs.length; i++) {
|
||||||
|
var doc = data.docs[i];
|
||||||
|
this.add(doc);
|
||||||
|
documents[doc.location] = doc;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
console.log('Lunr index built, search ready');
|
||||||
|
}
|
||||||
|
allowSearch = true;
|
||||||
|
postMessage({config: data.config});
|
||||||
|
postMessage({allowSearch: allowSearch});
|
||||||
|
}
|
||||||
|
|
||||||
|
function init () {
|
||||||
|
var oReq = new XMLHttpRequest();
|
||||||
|
oReq.addEventListener("load", onJSONLoaded);
|
||||||
|
var index_path = base_path + '/search_index.json';
|
||||||
|
if( 'function' === typeof importScripts ){
|
||||||
|
index_path = 'search_index.json';
|
||||||
|
}
|
||||||
|
oReq.open("GET", index_path);
|
||||||
|
oReq.send();
|
||||||
|
}
|
||||||
|
|
||||||
|
function search (query) {
|
||||||
|
if (!allowSearch) {
|
||||||
|
console.error('Assets for search still loading');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
var resultDocuments = [];
|
||||||
|
var results = index.search(query);
|
||||||
|
for (var i=0; i < results.length; i++){
|
||||||
|
var result = results[i];
|
||||||
|
doc = documents[result.ref];
|
||||||
|
doc.summary = doc.text.substring(0, 200);
|
||||||
|
resultDocuments.push(doc);
|
||||||
|
}
|
||||||
|
return resultDocuments;
|
||||||
|
}
|
||||||
|
|
||||||
|
if( 'function' === typeof importScripts ) {
|
||||||
|
onmessage = function (e) {
|
||||||
|
if (e.data.init) {
|
||||||
|
init();
|
||||||
|
} else if (e.data.query) {
|
||||||
|
postMessage({ results: search(e.data.query) });
|
||||||
|
} else {
|
||||||
|
console.error("Worker - Unrecognized message: " + e);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
@ -0,0 +1,19 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
|
||||||
|
<loc>None</loc>
|
||||||
|
<lastmod>2021-03-09</lastmod>
|
||||||
|
<changefreq>daily</changefreq>
|
||||||
|
</url><url>
|
||||||
|
<loc>None</loc>
|
||||||
|
<lastmod>2021-03-09</lastmod>
|
||||||
|
<changefreq>daily</changefreq>
|
||||||
|
</url><url>
|
||||||
|
<loc>None</loc>
|
||||||
|
<lastmod>2021-03-09</lastmod>
|
||||||
|
<changefreq>daily</changefreq>
|
||||||
|
</url><url>
|
||||||
|
<loc>None</loc>
|
||||||
|
<lastmod>2021-03-09</lastmod>
|
||||||
|
<changefreq>daily</changefreq>
|
||||||
|
</url>
|
||||||
|
</urlset>
|
||||||
Binary file not shown.
@ -0,0 +1,324 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html lang="en">
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
||||||
|
|
||||||
|
|
||||||
|
<title>Usage - UnitCommitment.jl</title>
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/all.css">
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.12.0/css/v4-shims.css">
|
||||||
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
|
||||||
|
<link href='//rsms.me/inter/inter.css' rel='stylesheet' type='text/css'>
|
||||||
|
<link href='//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,600,700&subset=latin-ext,latin' rel='stylesheet' type='text/css'>
|
||||||
|
<link href="../css/bootstrap-custom.min.css" rel="stylesheet">
|
||||||
|
<link href="../css/base.min.css" rel="stylesheet">
|
||||||
|
<link href="../css/cinder.min.css" rel="stylesheet">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/styles/github.min.css">
|
||||||
|
|
||||||
|
|
||||||
|
<link href="../css/custom.css" rel="stylesheet">
|
||||||
|
|
||||||
|
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/respond.js@1.4.2/dest/respond.min.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
|
||||||
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
||||||
|
<div class="container">
|
||||||
|
|
||||||
|
<!-- Collapsed navigation -->
|
||||||
|
<div class="navbar-header">
|
||||||
|
<!-- Expander button -->
|
||||||
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
|
||||||
|
<span class="sr-only">Toggle navigation</span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
<span class="icon-bar"></span>
|
||||||
|
</button>
|
||||||
|
|
||||||
|
|
||||||
|
<!-- Main title -->
|
||||||
|
|
||||||
|
|
||||||
|
<a class="navbar-brand" href="..">UnitCommitment.jl</a>
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<!-- Expanded navigation -->
|
||||||
|
<div class="navbar-collapse collapse">
|
||||||
|
<!-- Main navigation -->
|
||||||
|
<ul class="nav navbar-nav">
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="..">Home</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li class="active">
|
||||||
|
<a href="./">Usage</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../format/">Format</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<li >
|
||||||
|
<a href="../instances/">Instances</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<ul class="nav navbar-nav navbar-right">
|
||||||
|
<li>
|
||||||
|
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
|
||||||
|
<i class="fas fa-search"></i> Search
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li >
|
||||||
|
<a rel="prev" href="..">
|
||||||
|
<i class="fas fa-arrow-left"></i> Previous
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li >
|
||||||
|
<a rel="next" href="../format/">
|
||||||
|
Next <i class="fas fa-arrow-right"></i>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="https://github.com/ANL-CEEESA/unitcommitment.jl/edit/dev/src/docs/usage.md"><i class="fab fa-github"></i> Edit on GitHub</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="container">
|
||||||
|
|
||||||
|
|
||||||
|
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
|
||||||
|
<ul class="nav bs-sidenav">
|
||||||
|
<li class="first-level active"><a href="#usage">Usage</a></li>
|
||||||
|
<li class="second-level"><a href="#1-installation">1. Installation</a></li>
|
||||||
|
|
||||||
|
<li class="second-level"><a href="#2-typical-usage">2. Typical Usage</a></li>
|
||||||
|
|
||||||
|
<li class="third-level"><a href="#21-solving-user-provided-instances">2.1 Solving user-provided instances</a></li>
|
||||||
|
<li class="third-level"><a href="#22-solving-benchmark-instances">2.2 Solving benchmark instances</a></li>
|
||||||
|
<li class="second-level"><a href="#3-advanced-usage">3. Advanced usage</a></li>
|
||||||
|
|
||||||
|
<li class="third-level"><a href="#31-modifying-the-formulation">3.1 Modifying the formulation</a></li>
|
||||||
|
<li class="third-level"><a href="#32-generating-initial-conditions">3.2 Generating initial conditions</a></li>
|
||||||
|
<li class="third-level"><a href="#33-verifying-solutions">3.3 Verifying solutions</a></li>
|
||||||
|
</ul>
|
||||||
|
</div></div>
|
||||||
|
<div class="col-md-9" role="main">
|
||||||
|
|
||||||
|
<h1 id="usage">Usage</h1>
|
||||||
|
<h2 id="1-installation">1. Installation</h2>
|
||||||
|
<p>UnitCommitment.jl was tested and developed with <a href="https://julialang.org/">Julia 1.5</a>. To install Julia, please follow the <a href="https://julialang.org/downloads/platform.html">installation guide on the official Julia website</a>. To install UnitCommitment.jl, run the Julia interpreter, type <code>]</code> to open the package manager, then type:</p>
|
||||||
|
<pre><code class="language-text">pkg> add UnitCommitment
|
||||||
|
</code></pre>
|
||||||
|
<p>To test that the package has been correctly installed, run:</p>
|
||||||
|
<pre><code class="language-text">pkg> test UnitCommitment
|
||||||
|
</code></pre>
|
||||||
|
<p>If all tests pass, the package should now be ready to be used by any Julia script on the machine.</p>
|
||||||
|
<p>To solve the optimization models, a mixed-integer linear programming (MILP) solver is also required. Please see the <a href="https://jump.dev/JuMP.jl/stable/installation/">JuMP installation guide</a> for more instructions on installing a solver. Typical open-source choices are <a href="https://github.com/JuliaOpt/Cbc.jl">Cbc</a> and <a href="https://github.com/JuliaOpt/GLPK.jl">GLPK</a>. In the instructions below, Cbc will be used, but any other MILP solver listed in JuMP installation guide should also be compatible.</p>
|
||||||
|
<h2 id="2-typical-usage">2. Typical Usage</h2>
|
||||||
|
<h3 id="21-solving-user-provided-instances">2.1 Solving user-provided instances</h3>
|
||||||
|
<p>The first step to use UC.jl is to construct a JSON file describing your unit commitment instance. See the <a href="">data format page</a> for a complete description of the data format UC.jl expects. The next steps, as shown below, are to read the instance from file, construct the optimization model, run the optimization and extract the optimal solution.</p>
|
||||||
|
<pre><code class="language-julia">using Cbc
|
||||||
|
using JSON
|
||||||
|
using UnitCommitment
|
||||||
|
|
||||||
|
# Read instance
|
||||||
|
instance = UnitCommitment.read("/path/to/input.json")
|
||||||
|
|
||||||
|
# Construct optimization model
|
||||||
|
model = UnitCommitment.build_model(instance=instance,
|
||||||
|
optimizer=Cbc.Optimizer)
|
||||||
|
|
||||||
|
# Solve model
|
||||||
|
UnitCommitment.optimize!(model)
|
||||||
|
|
||||||
|
# Extract solution and write it to a file
|
||||||
|
solution = UnitCommitment.get_solution(model)
|
||||||
|
open("/path/to/output.json", "w") do file
|
||||||
|
JSON.print(file, solution, 2)
|
||||||
|
end
|
||||||
|
</code></pre>
|
||||||
|
<h3 id="22-solving-benchmark-instances">2.2 Solving benchmark instances</h3>
|
||||||
|
<p>As described in the <a href="../instances/">Instances page</a>, UnitCommitment.jl contains a number of benchmark instances collected from the literature. To solve one of these instances individually, instead of constructing your own, the function <code>read_benchmark</code> can be used:</p>
|
||||||
|
<pre><code class="language-julia">using UnitCommitment
|
||||||
|
instance = UnitCommitment.read_benchmark("matpower/case3375wp/2017-02-01")
|
||||||
|
</code></pre>
|
||||||
|
<h2 id="3-advanced-usage">3. Advanced usage</h2>
|
||||||
|
<h3 id="31-modifying-the-formulation">3.1 Modifying the formulation</h3>
|
||||||
|
<p>For the time being, the recommended way of modifying the MILP formulation used by UC.jl is to create a local copy of our git repository and directly modify the source code of the package. In a future version, it will be possible to switch between multiple formulations, or to simply add/remove constraints after the model has been generated.</p>
|
||||||
|
<h3 id="32-generating-initial-conditions">3.2 Generating initial conditions</h3>
|
||||||
|
<p>When creating random unit commitment instances for benchmark purposes, it is often hard to compute, in advance, sensible initial conditions for all generators. Setting initial conditions naively (for example, making all generators initially off and producing no power) can easily cause the instance to become infeasible due to excessive ramping. Initial conditions can also make it hard to modify existing instances. For example, increasing the system load without carefully modifying the initial conditions may make the problem infeasible or unrealistically challenging to solve.</p>
|
||||||
|
<p>To help with this issue, UC.jl provides a utility function which can generate feasible initial conditions by solving a single-period optimization problem, as shown below:</p>
|
||||||
|
<pre><code class="language-julia">using Cbc
|
||||||
|
using UnitCommitment
|
||||||
|
|
||||||
|
# Read original instance
|
||||||
|
instance = UnitCommitment.read("instance.json")
|
||||||
|
|
||||||
|
# Generate initial conditions (in-place)
|
||||||
|
UnitCommitment.generate_initial_conditions!(instance, Cbc.Optimizer)
|
||||||
|
|
||||||
|
# Construct and solve optimization model
|
||||||
|
model = UnitCommitment.build_model(instance, Cbc.Optimizer)
|
||||||
|
UnitCommitment.optimize!(model)
|
||||||
|
</code></pre>
|
||||||
|
<div class="admonition warning">
|
||||||
|
<p class="admonition-title">Warning</p>
|
||||||
|
<p>The function <code>generate_initial_conditions!</code> may return different initial conditions after each call, even if the same instance and the same optimizer is provided. The particular algorithm may also change in a future version of UC.jl. For these reasons, it is recommended that you generate initial conditions exactly once for each instance and store them for later use.</p>
|
||||||
|
</div>
|
||||||
|
<h3 id="33-verifying-solutions">3.3 Verifying solutions</h3>
|
||||||
|
<p>When developing new formulations, it is very easy to introduce subtle errors in the model that result in incorrect solutions. To help with this, UC.jl includes a utility function that verifies if a given solution is feasible, and, if not, prints all the validation errors it found. The implementation of this function is completely independent from the implementation of the optimization model, and therefore can be used to validate it. The function can also be used to verify solutions produced by other optimization packages, as long as they follow the <a href="../format/">UC.jl data format</a>.</p>
|
||||||
|
<pre><code class="language-julia">using JSON
|
||||||
|
using UnitCommitment
|
||||||
|
|
||||||
|
# Read instance
|
||||||
|
instance = UnitCommitment.read("instance.json")
|
||||||
|
|
||||||
|
# Read solution (potentially produced by other packages)
|
||||||
|
solution = JSON.parsefile("solution.json")
|
||||||
|
|
||||||
|
# Validate solution and print validation errors
|
||||||
|
UnitCommitment.validate(instance, solution)
|
||||||
|
</code></pre></div>
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<footer class="col-md-12 text-center">
|
||||||
|
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
<p>
|
||||||
|
<small>Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved.</small><br>
|
||||||
|
|
||||||
|
<small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</small>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</footer>
|
||||||
|
|
||||||
|
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
|
||||||
|
<script src="../js/bootstrap-3.0.3.min.js"></script>
|
||||||
|
|
||||||
|
|
||||||
|
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/highlight.min.js"></script>
|
||||||
|
|
||||||
|
<script src="//cdn.jsdelivr.net/gh/highlightjs/cdn-release@9.18.0/build/languages/julia.min.js"></script>
|
||||||
|
|
||||||
|
<script>hljs.initHighlightingOnLoad();</script>
|
||||||
|
|
||||||
|
|
||||||
|
<script>var base_url = ".."</script>
|
||||||
|
|
||||||
|
<script src="../js/base.js"></script>
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||||||
|
<script src="../js/mathjax.js"></script>
|
||||||
|
<script src="../search/main.js"></script>
|
||||||
|
|
||||||
|
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-dialog modal-lg">
|
||||||
|
<div class="modal-content">
|
||||||
|
<div class="modal-header">
|
||||||
|
<button type="button" class="close" data-dismiss="modal">
|
||||||
|
<span aria-hidden="true">×</span>
|
||||||
|
<span class="sr-only">Close</span>
|
||||||
|
</button>
|
||||||
|
<h4 class="modal-title" id="searchModalLabel">Search</h4>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<p>
|
||||||
|
From here you can search these documents. Enter
|
||||||
|
your search terms below.
|
||||||
|
</p>
|
||||||
|
<form>
|
||||||
|
<div class="form-group">
|
||||||
|
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
<div id="mkdocs-search-results"></div>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
|
||||||
|
<div class="modal-dialog">
|
||||||
|
<div class="modal-content">
|
||||||
|
<div class="modal-header">
|
||||||
|
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
|
||||||
|
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
|
||||||
|
</div>
|
||||||
|
<div class="modal-body">
|
||||||
|
<table class="table">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th style="width: 20%;">Keys</th>
|
||||||
|
<th>Action</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td class="help shortcut"><kbd>?</kbd></td>
|
||||||
|
<td>Open this help</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="next shortcut"><kbd>n</kbd></td>
|
||||||
|
<td>Next page</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="prev shortcut"><kbd>p</kbd></td>
|
||||||
|
<td>Previous page</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="search shortcut"><kbd>s</kbd></td>
|
||||||
|
<td>Search</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
Loading…
Reference in new issue