mirror of
https://github.com/ANL-CEEESA/RELOG.git
synced 2025-12-06 07:48:50 -06:00
Update 0.7 docs
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE html>
|
||||
<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
|
||||
</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><li><strong>John Atkins</strong></li><li><strong>Kyle Sun</strong></li><li><strong>Audrey Gallier</strong></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
|
||||
@@ -24,4 +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></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.24 on <span class="colophon-date" title="Thursday 23 February 2023 11:10">Thursday 23 February 2023</span>. Using Julia version 1.8.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
||||
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.24 on <span class="colophon-date" title="Thursday 23 February 2023 11:16">Thursday 23 February 2023</span>. Using Julia version 1.8.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|
||||
|
||||
Reference in New Issue
Block a user