mirror of https://github.com/ANL-CEEESA/RELOG.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
484 lines
18 KiB
484 lines
18 KiB
<!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="../img/favicon.ico">
|
|
|
|
|
|
<title>Model - RELOG</title>
|
|
|
|
|
|
<link rel="stylesheet" href="//use.fontawesome.com/releases/v5.5.0/css/all.css" integrity="sha384-B4dIYHKNBt8Bc12p+WXckhzcICo0wtJAoU8YZTY5qE0Id1GSseTk6S+L3BlXeVIU" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/hack-font@3.3.0/build/web/hack.min.css">
|
|
<link href='//fonts.googleapis.com/css?family=PT+Sans:400,400italic,700,700italic&subset=latin-ext,latin' 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 href="../css/highlight.min.css" rel="stylesheet">
|
|
<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]-->
|
|
|
|
<script src="//ajax.googleapis.com/ajax/libs/webfont/1.6.26/webfont.js"></script>
|
|
<script>
|
|
WebFont.load({
|
|
google: {
|
|
families: ['Open Sans', 'PT Sans']
|
|
}
|
|
});
|
|
</script>
|
|
|
|
|
|
|
|
|
|
</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="../install/">Install</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="active">
|
|
<a href="./">Model</a>
|
|
</li>
|
|
|
|
|
|
|
|
<li >
|
|
<a href="../optimize/">Optimize</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="../install/">
|
|
<i class="fas fa-arrow-left"></i> Previous
|
|
</a>
|
|
</li>
|
|
<li >
|
|
<a rel="next" href="../optimize/">
|
|
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="#modeling">Modeling</a></li>
|
|
<li class="second-level"><a href="#parameters">Parameters</a></li>
|
|
|
|
<li class="third-level"><a href="#example">Example</a></li>
|
|
<li class="second-level"><a href="#products">Products</a></li>
|
|
|
|
<li class="third-level"><a href="#example_1">Example</a></li>
|
|
<li class="second-level"><a href="#processing-plants">Processing Plants</a></li>
|
|
|
|
<li class="third-level"><a href="#example_2">Example</a></li>
|
|
<li class="second-level"><a href="#model-assumptions">Model Assumptions</a></li>
|
|
|
|
</ul>
|
|
</div></div>
|
|
<div class="col-md-9" role="main">
|
|
|
|
<h1 id="modeling">Modeling</h1>
|
|
<p>The first step when using RELOG is to describe the reverse logistics pipeline and the relevant data. 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>
|
|
<h2 id="parameters">Parameters</h2>
|
|
<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 periods</code></td>
|
|
<td>Number of time periods in the simulation.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="example">Example</h3>
|
|
<pre><code class="json">{
|
|
"parameters": {
|
|
"time periods": 2
|
|
}
|
|
}
|
|
</code></pre>
|
|
|
|
<h2 id="products">Products</h2>
|
|
<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</code></td>
|
|
<td>The cost (in dollars per km per tonnes) to transport this product. Must be a timeseries.</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</code></td>
|
|
<td>The latitude of the location, in degrees.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code>longitude</code></td>
|
|
<td>The longitude of the location, in degrees.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code>amount</code></td>
|
|
<td>The amount (in tonnes) of the product initially available at the location. Must be a timeseries.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="example_1">Example</h3>
|
|
<pre><code class="json">{
|
|
"products": {
|
|
"P1": {
|
|
"transportation cost": [0.015, 0.015],
|
|
"initial amounts": {
|
|
"C1": {
|
|
"latitude": 7.0,
|
|
"longitude": 7.0,
|
|
"amount": [934.56, 934.56]
|
|
},
|
|
"C2": {
|
|
"latitude": 7.0,
|
|
"longitude": 19.0,
|
|
"amount": [198.95, 198.95]
|
|
},
|
|
"C3": {
|
|
"latitude": 84.0,
|
|
"longitude": 76.0,
|
|
"amount": [212.97, 212.97]
|
|
}
|
|
}
|
|
},
|
|
"P2": {
|
|
"transportation cost": [0.02, 0.02]
|
|
},
|
|
"P3": {
|
|
"transportation cost": [0.0125, 0.0125]
|
|
},
|
|
"P4": {
|
|
"transportation cost": [0.0175, 0.0175]
|
|
}
|
|
}
|
|
}
|
|
</code></pre>
|
|
|
|
<h2 id="processing-plants">Processing Plants</h2>
|
|
<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</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>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</code></td>
|
|
<td>The latitude of the location, in degrees.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code>longitude</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</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</code></td>
|
|
<td>The cost (in dollars per tonnes) to dispose of the product. Must be a timeseries.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code>limit</code></td>
|
|
<td>The maximum amount (in tonnes) 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</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 (in dollars) to open a plant of this size.</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="left"><code>fixed operating cost</code></td>
|
|
<td>The cost (in dollars) 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</code></td>
|
|
<td>The cost (in dollars per tonnes) that the plant incurs to process each tonne of input. Must be a timeseries.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="example_2">Example</h3>
|
|
<pre><code class="json">{
|
|
"plants": {
|
|
"F1": {
|
|
"input": "P1",
|
|
"outputs": {
|
|
"P2": 0.2,
|
|
"P3": 0.5
|
|
},
|
|
"locations": {
|
|
"L1": {
|
|
"latitude": 0.0,
|
|
"longitude": 0.0,
|
|
"disposal": {
|
|
"P2": {
|
|
"cost": [-10.0, -12.0],
|
|
"limit": [1.0, 1.0]
|
|
}
|
|
},
|
|
"capacities": {
|
|
"100": {
|
|
"opening cost": [500, 530],
|
|
"fixed operating cost": [300.0, 310.0],
|
|
"variable operating cost": [5.0, 5.2]
|
|
},
|
|
"500": {
|
|
"opening cost": [750, 760],
|
|
"fixed operating cost": [400.0, 450.0],
|
|
"variable operating cost": [4.5, 4.7]
|
|
},
|
|
"700": {
|
|
"opening cost": [1000, 1000],
|
|
"fixed operating cost": [500.0, 600.0],
|
|
"variable operating cost": [4.0, 4.4]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
</code></pre>
|
|
|
|
<h2 id="model-assumptions">Model Assumptions</h2>
|
|
<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>Variable and fixed operating costs do not change according to plant size.</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>
|
|
</ul></div>
|
|
|
|
|
|
</div>
|
|
|
|
<footer class="col-md-12 text-center">
|
|
|
|
<hr>
|
|
<p>
|
|
<small>Copyright © 2020, UChicago Argonne, LLC. All Rights Reserved.<br></small>
|
|
|
|
<small>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</p></small>
|
|
|
|
|
|
|
|
</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="../js/highlight.pack.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">
|
|
<h4 class="modal-title" id="searchModalLabel">Search</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">
|
|
<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>
|