mirror of
https://github.com/ANL-CEEESA/RELOG.git
synced 2025-12-06 07:48:50 -06:00
Update 0.5 docs
This commit is contained in:
281
0.5/index.html
281
0.5/index.html
@@ -1,169 +1,7 @@
|
||||
<!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://github.com/ANL-CEEESA/RELOG">https://github.com/ANL-CEEESA/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="language-text">RELOG: Reverse Logistics Optimization
|
||||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · RELOG</title><script data-outdated-warner src="assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script><link href="assets/custom.css" rel="stylesheet" type="text/css"/></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>RELOG</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li><li><a class="tocitem" href="usage/">Usage</a></li><li><a class="tocitem" href="format/">Input and Output Data Formats</a></li><li><a class="tocitem" href="reports/">Simplified Solution Reports</a></li><li><a class="tocitem" href="model/">Optimization Model</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/ANL-CEEESA/RELOG/blob/master/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="RELOG:-Reverse-Logistics-Optimization"><a class="docs-heading-anchor" href="#RELOG:-Reverse-Logistics-Optimization">RELOG: Reverse Logistics Optimization</a><a id="RELOG:-Reverse-Logistics-Optimization-1"></a><a class="docs-heading-anchor-permalink" href="#RELOG:-Reverse-Logistics-Optimization" title="Permalink"></a></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><center>
|
||||
<img src="../assets/ex_transportation.png" width="1000px"/>
|
||||
</center><h3 id="Table-of-Contents"><a class="docs-heading-anchor" href="#Table-of-Contents">Table of Contents</a><a id="Table-of-Contents-1"></a><a class="docs-heading-anchor-permalink" href="#Table-of-Contents" title="Permalink"></a></h3><ul><li><a href="usage/#Usage">Usage</a></li><li class="no-marker"><ul><li><a href="usage/#.-Installation">1. Installation</a></li><li><a href="usage/#.-Modeling-the-problem">2. Modeling the problem</a></li><li><a href="usage/#.-Running-the-optimization">3. Running the optimization</a></li><li><a href="usage/#.-What-If-Analysis">4. What-If Analysis</a></li><li><a href="usage/#.-Advanced-options">5. Advanced options</a></li><li class="no-marker"><ul><li><a href="usage/#.1-Changing-the-solver">5.1 Changing the solver</a></li><li><a href="usage/#.2-Multi-period-heuristics">5.2 Multi-period heuristics</a></li></ul></li></ul></li><li><a href="format/#Input-and-Output-Data-Formats">Input and Output Data Formats</a></li><li class="no-marker"><ul><li><a href="format/#Input-Data-Format-(JSON)">Input Data Format (JSON)</a></li><li class="no-marker"><ul><li><a href="format/#Parameters">Parameters</a></li><li><a href="format/#Products">Products</a></li><li><a href="format/#Processing-plants">Processing plants</a></li><li><a href="format/#Geographic-database">Geographic database</a></li><li><a href="format/#Current-limitations">Current limitations</a></li></ul></li><li><a href="format/#Output-Data-Format-(JSON)">Output Data Format (JSON)</a></li></ul></li><li><a href="reports/#Simplified-Solution-Reports">Simplified Solution Reports</a></li><li class="no-marker"><ul><li><a href="reports/#Plants-report">Plants report</a></li><li class="no-marker"><ul><li><a href="reports/#Sample-charts">Sample charts</a></li></ul></li><li><a href="reports/#Plant-outputs-report">Plant outputs report</a></li><li class="no-marker"><ul><li><a href="reports/#Sample-charts-2">Sample charts</a></li></ul></li><li><a href="reports/#Plant-emissions-report">Plant emissions report</a></li><li class="no-marker"><ul><li><a href="reports/#Sample-charts-3">Sample charts</a></li></ul></li><li><a href="reports/#Products-report">Products report</a></li><li><a href="reports/#Transportation-report">Transportation report</a></li><li class="no-marker"><ul><li><a href="reports/#Sample-charts-4">Sample charts</a></li></ul></li><li><a href="reports/#Transportation-emissions-report">Transportation emissions report</a></li><li class="no-marker"><ul><li><a href="reports/#Sample-charts-5">Sample charts</a></li></ul></li></ul></li><li><a href="model/#Optimization-Model">Optimization Model</a></li><li class="no-marker"><ul><li><a href="model/#Mathematical-Description">Mathematical Description</a></li><li class="no-marker"><ul><li><a href="model/#Sets">Sets</a></li><li><a href="model/#Constants">Constants</a></li><li><a href="model/#Decision-variables">Decision variables</a></li><li><a href="model/#Objective-function">Objective function</a></li><li><a href="model/#Constraints">Constraints</a></li></ul></li></ul></li></ul><h3 id="Source-Code"><a class="docs-heading-anchor" href="#Source-Code">Source Code</a><a id="Source-Code-1"></a><a class="docs-heading-anchor-permalink" href="#Source-Code" title="Permalink"></a></h3><ul><li><a href="https://github.com/ANL-CEEESA/RELOG">https://github.com/ANL-CEEESA/RELOG</a></li></ul><h3 id="Authors"><a class="docs-heading-anchor" href="#Authors">Authors</a><a id="Authors-1"></a><a class="docs-heading-anchor-permalink" href="#Authors" title="Permalink"></a></h3><ul><li><strong>Alinson S. Xavier,</strong> Argonne National Laboratory <axavier@anl.gov></li><li><strong>Nwike Iloeje,</strong> Argonne National Laboratory <ciloeje@anl.gov></li></ul><h3 id="License"><a class="docs-heading-anchor" href="#License">License</a><a id="License-1"></a><a class="docs-heading-anchor-permalink" href="#License" title="Permalink"></a></h3><pre><code class="language-text hljs">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
|
||||
@@ -186,115 +24,4 @@ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
||||
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 : 2021-10-15 13:15:56.812011+00:00
|
||||
-->
|
||||
POSSIBILITY OF SUCH DAMAGE.</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="usage/">Usage »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.21 on <span class="colophon-date" title="Friday 26 August 2022 13:01">Friday 26 August 2022</span>. Using Julia version 1.7.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
||||
|
||||
Reference in New Issue
Block a user