mirror of https://github.com/ANL-CEEESA/RELOG.git
commit
37c3db1c5b
@ -0,0 +1,226 @@
|
||||
<!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>RELOG</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="/.">RELOG</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/">Data Format</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="/reports/">Reports</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="/model/">Optimization Model</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/RELOG/"><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>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,281 @@
|
||||
body {
|
||||
padding-top: 70px;
|
||||
}
|
||||
|
||||
h1[id]:before, h2[id]:before, h3[id]:before, h4[id]:before, h5[id]:before, h6[id]:before {
|
||||
content: "";
|
||||
display: block;
|
||||
margin-top: -75px;
|
||||
height: 75px;
|
||||
}
|
||||
|
||||
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% - 90px);
|
||||
}
|
||||
.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 */
|
||||
|
||||
/* 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 @@
|
||||
body{padding-top:70px}h1[id]:before,h2[id]:before,h3[id]:before,h4[id]:before,h5[id]:before,h6[id]:before{content:"";display:block;margin-top:-75px;height:75px}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% - 90px)}.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}.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,522 @@
|
||||
<!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>Data Format - RELOG</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="..">RELOG</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="./">Data Format</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="../reports/">Reports</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="../model/">Optimization Model</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="../reports/">
|
||||
Next <i class="fas fa-arrow-right"></i>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/ANL-CEEESA/RELOG/edit/master/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="#input-and-output-data-formats">Input and Output Data Formats</a></li>
|
||||
<li class="second-level"><a href="#input-data-format-json">Input Data Format (JSON)</a></li>
|
||||
|
||||
<li class="third-level"><a href="#parameters">Parameters</a></li>
|
||||
<li class="third-level"><a href="#products">Products</a></li>
|
||||
<li class="third-level"><a href="#processing-plants">Processing plants</a></li>
|
||||
<li class="third-level"><a href="#current-limitations">Current limitations</a></li>
|
||||
<li class="second-level"><a href="#output-data-format-json">Output Data Format (JSON)</a></li>
|
||||
|
||||
</ul>
|
||||
</div></div>
|
||||
<div class="col-md-9" role="main">
|
||||
|
||||
<h1 id="input-and-output-data-formats">Input and Output Data Formats</h1>
|
||||
<p>In this page, we describe the input and output JSON formats used by RELOG. In addition to these, RELOG can also produce <a href="../reports/">simplified reports</a> in tabular data format.</p>
|
||||
<h2 id="input-data-format-json">Input Data Format (JSON)</h2>
|
||||
<p>RELOG accepts as input a JSON file with three sections: <code>parameters</code>, <code>products</code> and <code>plants</code>. Below, we describe each section in more detail.</p>
|
||||
<h3 id="parameters">Parameters</h3>
|
||||
<p>The <strong>parameters</strong> section describes details about the simulation itself.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>time horizon (years)</code></td>
|
||||
<td>Number of years in the simulation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>building period (years)</code></td>
|
||||
<td>List of years in which we are allowed to open new plants. For example, if this parameter is set to <code>[1,2,3]</code>, we can only open plants during the first three years. By default, this equals <code>[1]</code>; that is, plants can only be opened during the first year.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="example">Example</h4>
|
||||
<pre><code class="json">{
|
||||
"parameters": {
|
||||
"time horizon (years)": 2,
|
||||
"building period (years)": [1]
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
|
||||
<h3 id="products">Products</h3>
|
||||
<p>The <strong>products</strong> section describes all products and subproducts in the simulation. The field <code>instance["Products"]</code> is a dictionary mapping the name of the product to a dictionary which describes its characteristics. Each product description contains the following keys:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>transportation cost ($/km/tonne)</code></td>
|
||||
<td>The cost to transport this product. Must be a timeseries.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>transportation energy (J/km/tonne)</code></td>
|
||||
<td>The energy required to transport this product. Must be a timeseries. Optional.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>transportation emissions (tonne/km/tonne)</code></td>
|
||||
<td>A dictionary mapping the name of each greenhouse gas, produced to transport one tonne of this product along one kilometer, to the amount of gas produced (in tonnes). Must be a timeseries. Optional.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>initial amounts</code></td>
|
||||
<td>A dictionary mapping the name of each location to its description (see below). If this product is not initially available, this key may be omitted. Must be a timeseries.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Each product may have some amount available at the beginning of each time period. In this case, the key <code>initial amounts</code> maps to a dictionary with the following keys:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>latitude (deg)</code></td>
|
||||
<td>The latitude of the location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>longitude (deg)</code></td>
|
||||
<td>The longitude of the location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount (tonne)</code></td>
|
||||
<td>The amount of the product initially available at the location. Must be a timeseries.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="example_1">Example</h4>
|
||||
<pre><code class="json">{
|
||||
"products": {
|
||||
"P1": {
|
||||
"initial amounts": {
|
||||
"C1": {
|
||||
"latitude (deg)": 7.0,
|
||||
"longitude (deg)": 7.0,
|
||||
"amount (tonne)": [934.56, 934.56]
|
||||
},
|
||||
"C2": {
|
||||
"latitude (deg)": 7.0,
|
||||
"longitude (deg)": 19.0,
|
||||
"amount (tonne)": [198.95, 198.95]
|
||||
},
|
||||
"C3": {
|
||||
"latitude (deg)": 84.0,
|
||||
"longitude (deg)": 76.0,
|
||||
"amount (tonne)": [212.97, 212.97]
|
||||
}
|
||||
},
|
||||
"transportation cost ($/km/tonne)": [0.015, 0.015],
|
||||
"transportation energy (J/km/tonne)": [0.12, 0.11],
|
||||
"transportation emissions (tonne/km/tonne)": {
|
||||
"CO2": [0.052, 0.050],
|
||||
"CH4": [0.003, 0.002]
|
||||
}
|
||||
},
|
||||
"P2": {
|
||||
"transportation cost ($/km/tonne)": [0.022, 0.020]
|
||||
},
|
||||
"P3": {
|
||||
"transportation cost ($/km/tonne)": [0.0125, 0.0125]
|
||||
},
|
||||
"P4": {
|
||||
"transportation cost ($/km/tonne)": [0.0175, 0.0175]
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
|
||||
<h3 id="processing-plants">Processing plants</h3>
|
||||
<p>The <strong>plants</strong> section describes the available types of reverse manufacturing plants, their potential locations and associated costs, as well as their inputs and outputs. The field <code>instance["Plants"]</code> is a dictionary mapping the name of the plant to a dictionary with the following keys:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>input</code></td>
|
||||
<td>The name of the product that this plant takes as input. Only one input is accepted per plant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>outputs (tonne/tonne)</code></td>
|
||||
<td>A dictionary specifying how many tonnes of each product is produced for each tonnes of input. For example, if the plant outputs 0.5 tonnes of P2 and 0.25 tonnes of P3 for each tonnes of P1 provided, then this entry should be <code>{"P2": 0.5, "P3": 0.25}</code>. If the plant does not output anything, this key may be omitted.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>energy (GJ/tonne)</code></td>
|
||||
<td>The energy required to process 1 tonne of the input. Must be a timeseries. Optional.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>emissions (tonne/tonne)</code></td>
|
||||
<td>A dictionary mapping the name of each greenhouse gas, produced to process each tonne of input, to the amount of gas produced (in tonne). Must be a timeseries. Optional.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>locations</code></td>
|
||||
<td>A dictionary mapping the name of the location to a dictionary which describes the site characteristics (see below).</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>Each type of plant is associated with a set of potential locations where it can be built. Each location is represented by a dictionary with the following keys:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>latitude (deg)</code></td>
|
||||
<td>The latitude of the location, in degrees.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>longitude (deg)</code></td>
|
||||
<td>The longitude of the location, in degrees.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>disposal</code></td>
|
||||
<td>A dictionary describing what products can be disposed locally at the plant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>capacities (tonne)</code></td>
|
||||
<td>A dictionary describing what plant sizes are allowed, and their characteristics.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The keys in the <code>disposal</code> dictionary should be the names of the products. The values are dictionaries with the following keys:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>cost ($/tonne)</code></td>
|
||||
<td>The cost to dispose of the product. Must be a timeseries.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>limit (tonne)</code></td>
|
||||
<td>The maximum amount that can be disposed of. If an unlimited amount can be disposed, this key may be omitted. Must be a timeseries.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<p>The keys in the <code>capacities (tonne)</code> dictionary should be the amounts (in tonnes). The values are dictionaries with the following keys:</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Key</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>opening cost ($)</code></td>
|
||||
<td>The cost to open a plant of this size.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>fixed operating cost ($)</code></td>
|
||||
<td>The cost to keep the plant open, even if the plant doesn't process anything. Must be a timeseries.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>variable operating cost ($/tonne)</code></td>
|
||||
<td>The cost that the plant incurs to process each tonne of input. Must be a timeseries.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="example_2">Example</h4>
|
||||
<pre><code class="json">{
|
||||
"plants": {
|
||||
"F1": {
|
||||
"input": "P1",
|
||||
"outputs (tonne/tonne)": {
|
||||
"P2": 0.2,
|
||||
"P3": 0.5
|
||||
},
|
||||
"energy (GJ/tonne)": [0.12, 0.11],
|
||||
"emissions (tonne/tonne)": {
|
||||
"CO2": [0.052, 0.050],
|
||||
"CH4": [0.003, 0.002]
|
||||
},
|
||||
"locations": {
|
||||
"L1": {
|
||||
"latitude (deg)": 0.0,
|
||||
"longitude (deg)": 0.0,
|
||||
"disposal": {
|
||||
"P2": {
|
||||
"cost ($/tonne)": [-10.0, -12.0],
|
||||
"limit (tonne)": [1.0, 1.0]
|
||||
}
|
||||
},
|
||||
"capacities (tonne)": {
|
||||
"100": {
|
||||
"opening cost ($)": [500, 530],
|
||||
"fixed operating cost ($)": [300.0, 310.0],
|
||||
"variable operating cost ($/tonne)": [5.0, 5.2]
|
||||
},
|
||||
"500": {
|
||||
"opening cost ($)": [750, 760],
|
||||
"fixed operating cost ($)": [400.0, 450.0],
|
||||
"variable operating cost ($/tonne)": [5.0, 5.2]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
|
||||
<h3 id="current-limitations">Current limitations</h3>
|
||||
<ul>
|
||||
<li>Each plant can only be opened exactly once. After open, the plant remains open until the end of the simulation.</li>
|
||||
<li>Plants can be expanded at any time, even long after they are open.</li>
|
||||
<li>All material available at the beginning of a time period must be entirely processed by the end of that time period. It is not possible to store unprocessed materials from one time period to the next.</li>
|
||||
<li>Up to two plant sizes are currently supported. Variable operating costs must be the same for all plant sizes.</li>
|
||||
</ul>
|
||||
<h2 id="output-data-format-json">Output Data Format (JSON)</h2>
|
||||
<p>To be documented.</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>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: 52 KiB |
|
After Width: | Height: | Size: 37 KiB |
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 91 KiB |
|
After Width: | Height: | Size: 586 KiB |
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 32 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,294 @@
|
||||
<!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 - RELOG</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=".">RELOG</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/">Data Format</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="reports/">Reports</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="model/">Optimization Model</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/RELOG/edit/master/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="#relog-reverse-logistics-optimization">RELOG: Reverse Logistics Optimization</a></li>
|
||||
<li class="second-level"><a href="#table-of-contents">Table of Contents</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="#license">License</a></li>
|
||||
|
||||
</ul>
|
||||
</div></div>
|
||||
<div class="col-md-9" role="main">
|
||||
|
||||
<h1 id="relog-reverse-logistics-optimization">RELOG: Reverse Logistics Optimization</h1>
|
||||
<p><strong>RELOG</strong> is an open-source supply chain optimization package focusing on reverse logistics and reverse manufacturing. The package uses Mixed-Integer Linear Programming to determine where to build recycling plants, what size should these plants have and which customers should be served by which plants. The package supports custom reverse logistics pipelines, with multiple types of plants, multiple types of product and multiple time periods.</p>
|
||||
<p><img src="images/ex_transportation.png" width="1000px"/></p>
|
||||
<h3 id="table-of-contents">Table of Contents</h3>
|
||||
<ul>
|
||||
<li><a href="usage/">Usage</a></li>
|
||||
<li><a href="format/">Input and Output Data Formats</a></li>
|
||||
<li><a href="reports/">Simplified Solution Reports</a></li>
|
||||
<li><a href="model/">Optimization model</a></li>
|
||||
</ul>
|
||||
<h3 id="source-code">Source Code</h3>
|
||||
<ul>
|
||||
<li><a href="https://anl-ceeesa.github.io/RELOG/">https://anl-ceeesa.github.io/RELOG/</a></li>
|
||||
</ul>
|
||||
<h3 id="authors">Authors</h3>
|
||||
<ul>
|
||||
<li><strong>Alinson S. Xavier,</strong> Argonne National Laboratory <<a href="mailto:axavier@anl.gov">axavier@anl.gov</a>></li>
|
||||
<li><strong>Nwike Iloeje,</strong> Argonne National Laboratory <<a href="mailto:ciloeje@anl.gov">ciloeje@anl.gov</a>></li>
|
||||
</ul>
|
||||
<h3 id="license">License</h3>
|
||||
<pre><code class="text">RELOG: Reverse Logistics Optimization
|
||||
Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted
|
||||
provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of
|
||||
conditions and the following disclaimer.
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of
|
||||
conditions and the following disclaimer in the documentation and/or other materials provided
|
||||
with the distribution.
|
||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to
|
||||
endorse or promote products derived from this software without specific prior written
|
||||
permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
|
||||
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
||||
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
||||
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
||||
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
||||
</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>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 : 2020-09-18 16:19:12.522909+00:00
|
||||
-->
|
||||
@ -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"]
|
||||
});
|
||||
@ -0,0 +1,428 @@
|
||||
<!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>Optimization Model - RELOG</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="..">RELOG</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/">Data Format</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="../reports/">Reports</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li class="active">
|
||||
<a href="./">Optimization Model</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="../reports/">
|
||||
<i class="fas fa-arrow-left"></i> Previous
|
||||
</a>
|
||||
</li>
|
||||
<li class="disabled">
|
||||
<a rel="next" >
|
||||
Next <i class="fas fa-arrow-right"></i>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/ANL-CEEESA/RELOG/edit/master/src/docs/model.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="#optimization-model">Optimization Model</a></li>
|
||||
<li class="second-level"><a href="#mathematical-description">Mathematical Description</a></li>
|
||||
|
||||
<li class="third-level"><a href="#sets">Sets</a></li>
|
||||
<li class="third-level"><a href="#constants">Constants</a></li>
|
||||
<li class="third-level"><a href="#decision-variables">Decision variables</a></li>
|
||||
<li class="third-level"><a href="#objective-function">Objective function</a></li>
|
||||
<li class="third-level"><a href="#constraints">Constraints</a></li>
|
||||
<li class="third-level"><a href="#complete-optimization-model">Complete optimization model</a></li>
|
||||
</ul>
|
||||
</div></div>
|
||||
<div class="col-md-9" role="main">
|
||||
|
||||
<h1 id="optimization-model">Optimization Model</h1>
|
||||
<p>In this page, we describe the precise mathematical optimization model used by RELOG to find the optimal logistics plan. This model is a variation of the classical Facility Location Problem, which has been widely studied in the operations research literature. To simplify the exposition, we present the simplified case where there is only one type of plant.</p>
|
||||
<h2 id="mathematical-description">Mathematical Description</h2>
|
||||
<h3 id="sets">Sets</h3>
|
||||
<ul>
|
||||
<li>$L$ - Set of locations holding the original material to be recycled</li>
|
||||
<li>$M$ - Set of materials recovered during the reverse manufacturing process</li>
|
||||
<li>$P$ - Set of potential plants to open</li>
|
||||
<li>$T = { 1, \ldots, t^{max} } $ - Set of time periods</li>
|
||||
</ul>
|
||||
<h3 id="constants">Constants</h3>
|
||||
<p><strong>Plants:</strong></p>
|
||||
<ul>
|
||||
<li>$c^\text{disp}_{pmt}$ - Cost of disposing one tonne of material $m$ at plant $p$ during time $t$ (<code>$/tonne/km</code>)</li>
|
||||
<li>$c^\text{exp}_{pt}$ - Cost of adding one tonne of capacity to plant $p$ at time $t$ (<code>$/tonne</code>)</li>
|
||||
<li>$c^\text{open}_{pt}$ - Cost of opening plant $p$ at time $t$, at minimum capacity (<code>$</code>)</li>
|
||||
<li>$c^\text{f-base}_{pt}$ - Fixed cost of keeping plant $p$ open during time period $t$ (<code>$</code>)</li>
|
||||
<li>$c^\text{f-exp}_{pt}$ - Increase in fixed cost for each additional tonne of capacity (<code>$/tonne</code>)</li>
|
||||
<li>$c^\text{var}_{pt}$ - Variable cost of processing one tonne of input at plant $p$ at time $t$ (<code>$/tonne</code>)</li>
|
||||
<li>$m^\text{min}_p$ - Minimum capacity of plant $p$ (<code>tonne</code>)</li>
|
||||
<li>$m^\text{max}_p$ - Maximum capacity of plant $p$ (<code>tonne</code>)</li>
|
||||
<li>$m^\text{disp}_{pmt}$ - Maximum amount of material $m$ that plant $p$ can dispose of during time $t$ (<code>tonne</code>)</li>
|
||||
</ul>
|
||||
<p><strong>Products:</strong></p>
|
||||
<ul>
|
||||
<li>$\alpha_{pm}$ - Amount of material $m$ recovered by plant $t$ for each tonne of original material (<code>tonne/tonne</code>)</li>
|
||||
<li>$m^\text{initial}_{lt}$ - Amount of original material to be recycled at location $l$ during time $t$ (<code>tonne</code>)</li>
|
||||
</ul>
|
||||
<p><strong>Transportation:</strong></p>
|
||||
<ul>
|
||||
<li>$c^\text{tr}_{t}$ - Transportation cost during time $t$ (<code>$/tonne/km</code>)</li>
|
||||
<li>$d_{lp}$ - Distance between plant $p$ and location $l$ (<code>km</code>)</li>
|
||||
</ul>
|
||||
<h3 id="decision-variables">Decision variables</h3>
|
||||
<ul>
|
||||
<li>$q_{mpt}$ - Amount of material $m$ recovered by plant $p$ during time $t$ (<code>tonne</code>)</li>
|
||||
<li>$u_{pt}$ - Binary variable that equals 1 if plant $p$ starts operating at time $t$ (<code>bool</code>)</li>
|
||||
<li>$w_{pt}$ - Extra capacity (amount above the minimum) added to plant $p$ during time $t$ (<code>tonne</code>)</li>
|
||||
<li>$x_{pt}$ - Binary variable that equals 1 if plant $p$ is operational at time $t$ (<code>bool</code>)</li>
|
||||
<li>$y_{lpt}$ - Amount of product sent from location $l$ to plant $p$ during time $t$ (<code>tonne</code>)</li>
|
||||
<li>$z_{mpt}$ - Amount of material $m$ disposed of by plant $p$ during time $t$ (<code>tonne</code>)</li>
|
||||
</ul>
|
||||
<h3 id="objective-function">Objective function</h3>
|
||||
<p>RELOG minimizes the overall capital, production and transportation costs:</p>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align*}
|
||||
\text{minimize} \;\; &
|
||||
\sum_{t \in T} \sum_{p \in P} \left[
|
||||
c^\text{open}_{pt} u_{pt} +
|
||||
c^\text{f-base}_{pt} x_{pt} +
|
||||
\sum_{i=1}^t c^\text{f-exp}_{pt} w_{pi} +
|
||||
c^{\text{exp}}_{pt} w_{pt}
|
||||
\right] + \\
|
||||
&
|
||||
\sum_{t \in T} \sum_{l \in L} \sum_{p \in P} \left[
|
||||
c^{\text{tr}}_t d_{lp} + c^{\text{var}}_{pt}
|
||||
\right] y_{lpt} + \\
|
||||
&
|
||||
\sum_{t \in T} \sum_{p \in P} \sum_{m \in M} c^{\text{disp}}_{pmt} z_{pmt}
|
||||
\end{align*}</script>
|
||||
</p>
|
||||
<p>In the first line, we have (i) opening costs, if plant starts operating at time $t$, (ii) fixed operating costs, if plant is operational, (iii) additional fixed operating costs coming from expansion performed in all previous time periods up to the current one, and finally (iv) the expansion costs during the current time period.
|
||||
In the second line, we have the transportation costs and the variable operating costs.
|
||||
In the third line, we have the disposal costs.</p>
|
||||
<h3 id="constraints">Constraints</h3>
|
||||
<ul>
|
||||
<li>All original materials must be sent to a plant:</li>
|
||||
</ul>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align}
|
||||
& \sum_{p \in P} y_{lpt} = m^\text{initial}_{lt}
|
||||
& \forall l \in L, t \in T
|
||||
\end{align}</script>
|
||||
</p>
|
||||
<ul>
|
||||
<li>Plants have a limited capacity:</li>
|
||||
</ul>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align}
|
||||
& \sum_{l \in L} y_{lpt} \leq m^\text{min}_p x_p + \sum_{i=1}^t w_p
|
||||
& \forall p \in P, t \in T
|
||||
\end{align}</script>
|
||||
</p>
|
||||
<ul>
|
||||
<li>Plants can only be expanded up to their maximum capacity. Furthermore, if a plant is closed, it cannot be expanded:</li>
|
||||
</ul>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align}
|
||||
& \sum_{i=1}^t w_p \leq m^\text{max}_p x_p
|
||||
& \forall p \in P, t \in T
|
||||
\end{align}</script>
|
||||
</p>
|
||||
<ul>
|
||||
<li>Amount of recovered material is proportional to the plant input: </li>
|
||||
</ul>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align}
|
||||
& q_{mpt} = \alpha_{pm} \sum_{l \in L} y_{lpt}
|
||||
& \forall m \in M, p \in P, t \in T
|
||||
\end{align}</script>
|
||||
</p>
|
||||
<ul>
|
||||
<li>Because we only consider a single type of plant, all recovered material must be immediately disposed of. In RELOG's full model, recovered materials may be sent to another plant for further processing.</li>
|
||||
</ul>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align}
|
||||
& q_{mpt} = z_{mpt}
|
||||
& \forall m \in M, p \in P, t \in T
|
||||
\end{align}</script>
|
||||
</p>
|
||||
<ul>
|
||||
<li>A plant is operation at time $t$ if it was operational at time $t-1$ or it was built at time $t$. This constraint also prevents a plant from being built multiple times.</li>
|
||||
</ul>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align}
|
||||
& x_{pt} = x_{p,t-1} + u_{pt}
|
||||
& \forall p \in P, t \in T \setminus \{1\} \\
|
||||
& x_{p,1} = u_{p,1}
|
||||
& \forall p \in P
|
||||
\end{align}</script>
|
||||
</p>
|
||||
<ul>
|
||||
<li>Variable bounds:</li>
|
||||
</ul>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align}
|
||||
& q_{mpt} \geq 0
|
||||
& \forall m \in M, p \in P, t \in T \\
|
||||
& u_{pt} \in \{0,1\}
|
||||
& \forall p \in P, t \in T \\
|
||||
& w_{pt} \geq 0
|
||||
& \forall p \in P, t \in T \\
|
||||
& x_{pt} \in \{0,1\}
|
||||
& \forall p \in P, t \in T \\
|
||||
& y_{lpt} \geq 0
|
||||
& \forall l \in L, p \in P, t \in T \\
|
||||
& m^\text{disp}_{mpt} \geq z_{mpt} \geq 0
|
||||
& \forall m \in M, p \in P, t \in T
|
||||
\end{align}</script>
|
||||
</p>
|
||||
<h3 id="complete-optimization-model">Complete optimization model</h3>
|
||||
<p>
|
||||
<script type="math/tex; mode=display">\begin{align*}
|
||||
\text{minimize} \;\; &
|
||||
\sum_{t \in T} \sum_{p \in P} \left[
|
||||
c^\text{open}_{pt} u_{pt} +
|
||||
c^\text{f-base}_{pt} x_{pt} +
|
||||
\sum_{i=1}^t c^\text{f-exp}_{pt} w_{pi} +
|
||||
c^{\text{exp}}_{pt} w_{pt}
|
||||
\right] + \\
|
||||
&
|
||||
\sum_{t \in T} \sum_{l \in L} \sum_{p \in P} \left[
|
||||
c^{\text{tr}}_t d_{lp} + c^{\text{var}}_{pt}
|
||||
\right] y_{lpt} + \\
|
||||
&
|
||||
\sum_{t \in T} \sum_{p \in P} \sum_{m \in M} c^{\text{disp}}_{pmt} z_{pmt} \\
|
||||
\text{subject to } & \sum_{p \in P} y_{lpt} = m^\text{initial}_{lt}
|
||||
& \forall l \in L, t \in T \\
|
||||
& \sum_{l \in L} y_{lpt} \leq m^\text{min}_p x_p + \sum_{i=1}^t w_p
|
||||
& \forall p \in P, t \in T \\
|
||||
& \sum_{i=1}^t w_p \leq m^\text{max}_p x_p
|
||||
& \forall p \in P, t \in T \\
|
||||
& q_{mpt} = \alpha_{pm} \sum_{l \in L} y_{lpt}
|
||||
& \forall m \in M, p \in P, t \in T \\
|
||||
& q_{mpt} = z_{mpt}
|
||||
& \forall m \in M, p \in P, t \in T \\
|
||||
& x_{pt} = x_{p,t-1} + u_{pt}
|
||||
& \forall p \in P, t \in T \setminus \{1\} \\
|
||||
& x_{p,1} = u_{p,1}
|
||||
& \forall p \in P \\
|
||||
& q_{mpt} \geq 0
|
||||
& \forall m \in M, p \in P, t \in T \\
|
||||
& u_{pt} \in \{0,1\}
|
||||
& \forall p \in P, t \in T \\
|
||||
& w_{pt} \geq 0
|
||||
& \forall p \in P, t \in T \\
|
||||
& x_{pt} \in \{0,1\}
|
||||
& \forall p \in P, t \in T \\
|
||||
& y_{lpt} \geq 0
|
||||
& \forall l \in L, p \in P, t \in T \\
|
||||
& m^\text{disp}_{mpt} \geq z_{mpt} \geq 0
|
||||
& \forall m \in M, p \in P, t \in T
|
||||
\end{align*}</script>
|
||||
</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>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,693 @@
|
||||
<!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>Reports - RELOG</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="..">RELOG</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/">Data Format</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li class="active">
|
||||
<a href="./">Reports</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="../model/">Optimization Model</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="../format/">
|
||||
<i class="fas fa-arrow-left"></i> Previous
|
||||
</a>
|
||||
</li>
|
||||
<li >
|
||||
<a rel="next" href="../model/">
|
||||
Next <i class="fas fa-arrow-right"></i>
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/ANL-CEEESA/RELOG/edit/master/src/docs/reports.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="#simplified-solution-reports">Simplified Solution Reports</a></li>
|
||||
<li class="second-level"><a href="#plants-report">Plants report</a></li>
|
||||
|
||||
<li class="third-level"><a href="#sample-charts">Sample charts</a></li>
|
||||
<li class="second-level"><a href="#plant-outputs-report">Plant outputs report</a></li>
|
||||
|
||||
<li class="third-level"><a href="#sample-charts_1">Sample charts</a></li>
|
||||
<li class="second-level"><a href="#plant-emissions-report">Plant emissions report</a></li>
|
||||
|
||||
<li class="third-level"><a href="#sample-charts_2">Sample charts</a></li>
|
||||
<li class="second-level"><a href="#transportation-report">Transportation report</a></li>
|
||||
|
||||
<li class="third-level"><a href="#sample-charts_3">Sample charts</a></li>
|
||||
<li class="second-level"><a href="#transportation-emissions-report">Transportation emissions report</a></li>
|
||||
|
||||
<li class="third-level"><a href="#sample-charts_4">Sample charts</a></li>
|
||||
</ul>
|
||||
</div></div>
|
||||
<div class="col-md-9" role="main">
|
||||
|
||||
<h1 id="simplified-solution-reports">Simplified Solution Reports</h1>
|
||||
<p>In addition to the full output format described in <a href="../format/">data formats</a>, RELOG can also generate a number of simplified reports in tabular data format (CSV), which can be more easily processed by spreadsheet software (such as Microsoft Excel), by data analysis libraries (such as Pandas) or by relational databases (such as SQLite).</p>
|
||||
<p>In this page, we also illustrate what types of charts and visualizations can be produced from these tabular data files. The sample charts have been produced using Python, matplotlib, seaborn and geopandas.</p>
|
||||
<h2 id="plants-report">Plants report</h2>
|
||||
<p>Report showing plant costs, capacities, energy expenditure and utilization factors.</p>
|
||||
<p>Generated by <code>RELOG.write_plants_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_plants.csv">nimh_plants.csv</a>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Column</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>plant type</code></td>
|
||||
<td>Plant type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>location name</code></td>
|
||||
<td>Location name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>year</code></td>
|
||||
<td>What year this row corresponds to. This reports includes one row for each year in the simulation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>latitude (deg)</code></td>
|
||||
<td>Latitude of the plant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>longitude (deg)</code></td>
|
||||
<td>Longitude of the plant.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>capacity (tonne)</code></td>
|
||||
<td>Capacity of the plant at this point in time.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount processed (tonne)</code></td>
|
||||
<td>Amount of input material received by the plant this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>utilization factor (%)</code></td>
|
||||
<td>Amount processed by the plant this year divided by current plant capacity.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>energy (GJ)</code></td>
|
||||
<td>Amount of energy expended by the plant this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>opening cost ($)</code></td>
|
||||
<td>Amount spent opening the plant. This value is only positive if the plant became operational this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>expansion cost ($)</code></td>
|
||||
<td>Amount spent this year expanding the plant capacity.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>fixed operating cost ($)</code></td>
|
||||
<td>Amount spent for keeping the plant operational this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>variable operating cost ($)</code></td>
|
||||
<td>Amount spent for processing the input material this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>total cost ($)</code></td>
|
||||
<td>Sum of all previous plant costs.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sample-charts">Sample charts</h3>
|
||||
<ul>
|
||||
<li>Bar plot with total plant costs per year, grouped by plant type (in Python):</li>
|
||||
</ul>
|
||||
<pre><code class="python">import pandas as pd
|
||||
import seaborn as sns; sns.set()
|
||||
|
||||
data = pd.read_csv("plants_report.csv")
|
||||
sns.barplot(x="year",
|
||||
y="total cost ($)",
|
||||
hue="plant type",
|
||||
data=data.groupby(["plant type", "year"])
|
||||
.sum()
|
||||
.reset_index());
|
||||
</code></pre>
|
||||
|
||||
<p><img src="../images/ex_plant_cost_per_year.png" width="500px"/></p>
|
||||
<ul>
|
||||
<li>Map showing plant locations (in Python):</li>
|
||||
</ul>
|
||||
<pre><code class="python">import pandas as pd
|
||||
import geopandas as gp
|
||||
|
||||
# Plot base map
|
||||
world = gp.read_file(gp.datasets.get_path('naturalearth_lowres'))
|
||||
world = world[world.continent == 'North America']
|
||||
ax = world.plot(color='white', edgecolor='50', figsize=(15,15))
|
||||
|
||||
# Plot plant locations
|
||||
data = pd.read_csv("plants_report.csv")
|
||||
points = gp.points_from_xy(data["longitude (deg)"],
|
||||
data["latitude (deg)"])
|
||||
gp.GeoDataFrame(data, geometry=points).plot(ax=ax);
|
||||
</code></pre>
|
||||
|
||||
<p><img src="../images/ex_plant_locations.png" width="1000px"/></p>
|
||||
<h2 id="plant-outputs-report">Plant outputs report</h2>
|
||||
<p>Report showing amount of products produced, sent and disposed of by each plant, as well as disposal costs.</p>
|
||||
<p>Generated by <code>RELOG.write_plant_outputs_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_plant_outputs.csv">nimh_plant_outputs.csv</a>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Column</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>plant type</code></td>
|
||||
<td>Plant type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>location name</code></td>
|
||||
<td>Location name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>year</code></td>
|
||||
<td>What year this row corresponds to. This reports includes one row for each year in the simulation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>product</code></td>
|
||||
<td>Product being produced.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount produced (tonne)</code></td>
|
||||
<td>Amount of product produced this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount sent (tonne)</code></td>
|
||||
<td>Amount of product produced by this plant and sent to another plant for further processing this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount disposed (tonne)</code></td>
|
||||
<td>Amount produced produced by this plant and immediately disposed of locally this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>disposal cost ($)</code></td>
|
||||
<td>Disposal cost for this year.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sample-charts_1">Sample charts</h3>
|
||||
<ul>
|
||||
<li>Bar plot showing total amount produced for each product, grouped by year (in Python):</li>
|
||||
</ul>
|
||||
<pre><code class="python">import pandas as pd
|
||||
import seaborn as sns; sns.set()
|
||||
|
||||
data = pd.read_csv("plant_outputs_report.csv")
|
||||
sns.barplot(x="amount produced (tonne)",
|
||||
y="product name",
|
||||
hue="year",
|
||||
data=data.groupby(["product name", "year"])
|
||||
.sum()
|
||||
.reset_index());
|
||||
</code></pre>
|
||||
|
||||
<p><img src="../images/ex_amount_produced.png" width="500px"/></p>
|
||||
<h2 id="plant-emissions-report">Plant emissions report</h2>
|
||||
<p>Report showing amount of emissions produced by each plant.</p>
|
||||
<p>Generated by <code>RELOG.write_plant_emissions_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_plant_emissions.csv">nimh_plant_emissions.csv</a>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Column</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>plant type</code></td>
|
||||
<td>Plant type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>location name</code></td>
|
||||
<td>Location name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>year</code></td>
|
||||
<td>Year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>emission type</code></td>
|
||||
<td>Type of emission.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount (tonne)</code></td>
|
||||
<td>Amount of emission produced by the plant this year.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sample-charts_2">Sample charts</h3>
|
||||
<ul>
|
||||
<li>Bar plot showing total emission by plant type, grouped type of emissions (in Python):</li>
|
||||
</ul>
|
||||
<pre><code class="python">import pandas as pd
|
||||
import seaborn as sns; sns.set()
|
||||
|
||||
data = pd.read_csv("plant_emissions_report.csv")
|
||||
sns.barplot(x="plant type",
|
||||
y="emission amount (tonne)",
|
||||
hue="emission type",
|
||||
data=data.groupby(["plant type", "emission type"])
|
||||
.sum()
|
||||
.reset_index());
|
||||
</code></pre>
|
||||
|
||||
<p><img src="../images/ex_emissions.png" width="500px"/></p>
|
||||
<h2 id="transportation-report">Transportation report</h2>
|
||||
<p>Report showing amount of product sent from initial locations to plants, and from one plant to another. Includes the distance between each pair of locations, amount-distance shipped, transportation costs and energy expenditure.</p>
|
||||
<p>Generated by <code>RELOG.write_transportation_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_transportation.csv">nimh_transportation.csv</a>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Column</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>source type</code></td>
|
||||
<td>If product is being shipped from an initial location, equals <code>Origin</code>. If product is being shipped from a plant, equals plant type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>source location name</code></td>
|
||||
<td>Name of the location where the product is being shipped from.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>source latitude (deg)</code></td>
|
||||
<td>Latitude of the source location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>source longitude (deg)</code></td>
|
||||
<td>Longitude of the source location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>destination type</code></td>
|
||||
<td>Type of plant the product is being shipped to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>destination location name</code></td>
|
||||
<td>Name of the location where the product is being shipped to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>destination latitude (deg)</code></td>
|
||||
<td>Latitude of the destination location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>destination longitude (deg)</code></td>
|
||||
<td>Longitude of the destination location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>product</code></td>
|
||||
<td>Product being shipped.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>year</code></td>
|
||||
<td>Year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>distance (km)</code></td>
|
||||
<td>Distance between source and destination.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount (tonne)</code></td>
|
||||
<td>Total amount of product being shipped between the two locations this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount-distance (tonne-km)</code></td>
|
||||
<td>Total amount being shipped this year times distance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>transportation cost ($)</code></td>
|
||||
<td>Cost to transport this amount of product between the two locations for this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>transportation energy (GJ)</code></td>
|
||||
<td>Energy expended transporting this amount of product between the two locations.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sample-charts_3">Sample charts</h3>
|
||||
<ul>
|
||||
<li>Bar plot showing total amount-distance for each product type, grouped by year (in Python):</li>
|
||||
</ul>
|
||||
<pre><code class="python">import pandas as pd
|
||||
import seaborn as sns; sns.set()
|
||||
|
||||
data = pd.read_csv("transportation_report.csv")
|
||||
sns.barplot(x="product",
|
||||
y="amount-distance (tonne-km)",
|
||||
hue="year",
|
||||
data=data.groupby(["product", "year"])
|
||||
.sum()
|
||||
.reset_index());
|
||||
</code></pre>
|
||||
|
||||
<p><img src="../images/ex_transportation_amount_distance.png" width="500px"/></p>
|
||||
<ul>
|
||||
<li>Map of transportation lines (in Python):</li>
|
||||
</ul>
|
||||
<pre><code class="python">import pandas as pd
|
||||
import geopandas as gp
|
||||
from shapely.geometry import Point, LineString
|
||||
import matplotlib.pyplot as plt
|
||||
from matplotlib import collections
|
||||
|
||||
# Plot base map
|
||||
world = gp.read_file(gp.datasets.get_path('naturalearth_lowres'))
|
||||
ax = world.plot(color='white', edgecolor='50', figsize=(14,7))
|
||||
ax.set_ylim([23, 50])
|
||||
ax.set_xlim([-128, -65])
|
||||
|
||||
# Draw transportation lines
|
||||
data = pd.read_csv("transportation_report.csv")
|
||||
lines = [[(row["source longitude (deg)"], row["source latitude (deg)"]),
|
||||
(row["destination longitude (deg)"], row["destination latitude (deg)"])
|
||||
] for (index, row) in data.iterrows()]
|
||||
ax.add_collection(collections.LineCollection(lines,
|
||||
linewidths=0.25,
|
||||
zorder=1,
|
||||
alpha=0.5,
|
||||
color="50"))
|
||||
|
||||
# Draw source points
|
||||
points = gp.points_from_xy(data["source longitude (deg)"],
|
||||
data["source latitude (deg)"])
|
||||
gp.GeoDataFrame(data, geometry=points).plot(ax=ax,
|
||||
color="0.5",
|
||||
markersize=1);
|
||||
|
||||
# Draw destination points
|
||||
points = gp.points_from_xy(data["destination longitude (deg)"],
|
||||
data["destination latitude (deg)"])
|
||||
gp.GeoDataFrame(data, geometry=points).plot(ax=ax,
|
||||
color="red",
|
||||
markersize=50);
|
||||
</code></pre>
|
||||
|
||||
<p><img src="../images/ex_transportation.png" width="1000px"/></p>
|
||||
<h2 id="transportation-emissions-report">Transportation emissions report</h2>
|
||||
<p>Report showing emissions for each trip between initial locations and plants, and between pairs of plants.</p>
|
||||
<p>Generated by <code>RELOG.write_transportation_emissions_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_transportation_emissions.csv">nimh_transportation_emissions.csv</a>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Column</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>source type</code></td>
|
||||
<td>If product is being shipped from an initial location, equals <code>Origin</code>. If product is being shipped from a plant, equals plant type.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>source location name</code></td>
|
||||
<td>Name of the location where the product is being shipped from.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>source latitude (deg)</code></td>
|
||||
<td>Latitude of the source location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>source longitude (deg)</code></td>
|
||||
<td>Longitude of the source location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>destination type</code></td>
|
||||
<td>Type of plant the product is being shipped to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>destination location name</code></td>
|
||||
<td>Name of the location where the product is being shipped to.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>destination latitude (deg)</code></td>
|
||||
<td>Latitude of the destination location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>destination longitude (deg)</code></td>
|
||||
<td>Longitude of the destination location.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>product</code></td>
|
||||
<td>Product being shipped.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>year</code></td>
|
||||
<td>Year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>distance (km)</code></td>
|
||||
<td>Distance between source and destination.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>shipped amount (tonne)</code></td>
|
||||
<td>Total amount of product being shipped between the two locations this year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>shipped amount-distance (tonne-km)</code></td>
|
||||
<td>Total amount being shipped this year times distance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>emission type</code></td>
|
||||
<td>Type of emission.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>emission amount (tonne)</code></td>
|
||||
<td>Amount of emission produced by transportation segment this year.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="sample-charts_4">Sample charts</h3>
|
||||
<ul>
|
||||
<li>Bar plot showing total emission amount by emission type, grouped by type of product being transported (in Python):</li>
|
||||
</ul>
|
||||
<pre><code class="python">import pandas as pd
|
||||
import seaborn as sns; sns.set()
|
||||
|
||||
data = pd.read_csv("transportation_emissions_report.csv")
|
||||
sns.barplot(x="emission type",
|
||||
y="emission amount (tonne)",
|
||||
hue="product",
|
||||
data=data.groupby(["product", "emission type"])
|
||||
.sum()
|
||||
.reset_index());
|
||||
</code></pre>
|
||||
|
||||
<p><img src="../images/ex_transportation_emissions.png" width="500px"/></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>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>
|
||||
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,23 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2020-09-18</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2020-09-18</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2020-09-18</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2020-09-18</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2020-09-18</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
</urlset>
|
||||
Binary file not shown.
@ -0,0 +1,313 @@
|
||||
<!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 - RELOG</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="..">RELOG</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/">Data Format</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="../reports/">Reports</a>
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
<li >
|
||||
<a href="../model/">Optimization Model</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/RELOG/edit/master/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-modeling-the-problem">2. Modeling the problem</a></li>
|
||||
|
||||
<li class="second-level"><a href="#3-running-the-optimization">3. Running the optimization</a></li>
|
||||
|
||||
<li class="second-level"><a href="#4-advanced-options">4. Advanced options</a></li>
|
||||
|
||||
<li class="third-level"><a href="#41-changing-the-solver">4.1 Changing the solver</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>To use RELOG, the first step is to install the <a href="https://julialang.org/">Julia programming language</a> on your machine. Note that RELOG was developed and tested with Julia 1.5 and may not be compatible with newer versions. After Julia is installed, launch the Julia console, type <code>]</code> to switch to package manger mode, then run:</p>
|
||||
<pre><code class="text">(@v1.5) pkg> add https://github.com/ANL-CEEESA/RELOG.git
|
||||
</code></pre>
|
||||
|
||||
<p>After the package and all its dependencies have been installed, please run the RELOG test suite, as shown below, to make sure that the package has been correctly installed:</p>
|
||||
<pre><code class="text">(@v1.5) pkg> test RELOG
|
||||
</code></pre>
|
||||
|
||||
<p>To update the package to a newer version, type <code>]</code> to enter the package manager mode, then run:</p>
|
||||
<pre><code class="text">(@v1.5) pkg> update RELOG
|
||||
</code></pre>
|
||||
|
||||
<h2 id="2-modeling-the-problem">2. Modeling the problem</h2>
|
||||
<p>The two main model components in RELOG are <strong>products</strong> and <strong>plants</strong>.</p>
|
||||
<p>A <strong>product</strong> is any material that needs to be recycled, any intermediary product produced during the recycling process, or any product recovered at the end of the process. For example, in a NiMH battery recycling study case, products could include (i) the original batteries to be recycled; (ii) the cathode and anode parts of the battery; (iii) rare-earth elements and (iv) scrap metals.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>The model assumes that some products are initially available at user-specified locations (described by their latitude, longitude and the amount available), while other products only become available during the recycling process.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Transporting products from one location to another incurs a transportation cost (<code>$/km/tonne</code>), spends some amount of energy (<code>J/km/tonne</code>) and may generate multiple types of emissions (<code>tonne/tonne</code>). All these parameters are user-specified and may be product- and time-specific.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>A <strong>plant</strong> is a facility that converts one type of product to another. RELOG assumes that each plant receives a single type of product as input and converts this input into multiple types of products. Multiple types of plants, with different inputs, outputs and performance characteristics, may be specified. In the NiMH battery recycling study case, for example, one type of plant could be a <em>disassembly plant</em>, which converts <em>batteries</em> into <em>cathode</em> and <em>anode</em>. Another type of plant could be <em>anode recycling plant</em>, which converts <em>anode</em> into <em>rare-earth elements</em> and <em>scrap metals</em>.</p>
|
||||
<ul>
|
||||
<li>
|
||||
<p>To process each tonne of input material, plants incur a variable operating cost (<code>$/tonne</code>), spend some amount of energy (<code>GJ/tonne</code>), and produce multiple types of emissions (<code>tonne/tonne</code>). Plants also incur a fixed operating cost (<code>$</code>) regardless of the amount of material they process. All these parameters are user-specified and may be region- and time-specific.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Plants can be built at user-specified potential locations. Opening a plant incurs a one-time opening cost (<code>$</code>) which may be region- and time-specific. Plants also have a limited capacity (in <code>tonne</code>), which indicates the maximum amount of input material they are able to process per year. When specifying potential locations for each type of plant, it is also possible to specify the minimum and maximum capacity of the plants that can be built at that particular location. Different plants sizes may have different opening costs and fixed operating costs. After a plant is built, it can be further expanded in the following years, up to its maximum capacity.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>All products that are initially available must be sent to a plant for processing. All products that are generated by a plant can either be sent to another plant for further processing, or disposed of locally for either a profit or a loss (<code>$/tonne</code>). To model environmental regulations, it is also possible to specify the maximum amount of each product that can be disposed of at each location.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<p>All user parameters specified above must be provided to RELOG as a JSON file, which is fully described in the <a href="../format/">data format page</a>.</p>
|
||||
<h2 id="3-running-the-optimization">3. Running the optimization</h2>
|
||||
<p>After creating a JSON file describing the reverse manufacturing process and the input data, the following example illustrates how to use the package to find the optimal set of decisions:</p>
|
||||
<pre><code class="julia"># Import package
|
||||
using RELOG
|
||||
|
||||
# Solve optimization problem
|
||||
solution = RELOG.solve("/home/user/instance.json")
|
||||
|
||||
# Write full solution in JSON format
|
||||
RELOG.write(solution, "solution.json")
|
||||
|
||||
# Write simplified reports in CSV format
|
||||
RELOG.write_plants_report(solution, "plants.csv")
|
||||
RELOG.write_transportation_report(solution, "transportation.csv")
|
||||
</code></pre>
|
||||
|
||||
<p>For a complete description of the file formats above, and for a complete list of available reports, see the <a href="../format/">data format page</a>.</p>
|
||||
<h2 id="4-advanced-options">4. Advanced options</h2>
|
||||
<h3 id="41-changing-the-solver">4.1 Changing the solver</h3>
|
||||
<p>By default, RELOG internally uses <a href="https://github.com/coin-or/Cbc">Cbc</a>, an open-source and freely-available Mixed-Integer Linear Programming solver developed by the <a href="https://www.coin-or.org/">COIN-OR Project</a>. For larger-scale test cases, a commercial solver such as Gurobi, CPLEX or XPRESS is recommended. The following snippet shows how to switch from Cbc to Gurobi, for example:</p>
|
||||
<pre><code class="julia">using RELOG, Gurobi, JuMP
|
||||
|
||||
gurobi = optimizer_with_attributes(Gurobi.Optimizer,
|
||||
"TimeLimit" => 3600,
|
||||
"MIPGap" => 0.001)
|
||||
|
||||
RELOG.solve("instance.json",
|
||||
output="solution.json",
|
||||
optimizer=gurobi)
|
||||
</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>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 @@
|
||||
<meta http-equiv="Refresh" content="0; url='/RELOG/0.3'" />
|
||||
Loading…
Reference in new issue