ANL-CEEESA/RELOG
1
0
Fork 0
mirror of https://github.com/ANL-CEEESA/RELOG.git synced 2025-12-06 07:48:50 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update 0.7 docs

Browse Source
This commit is contained in:
Alinson S. Xavier
2023-02-23 11:17:05 -06:00
parent 78ba1f2c6f
commit dab5fe025c
7 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
0.7/format/index.html
View File

@@ -103,4 +103,4 @@
"amount (tonne)": [934.56, 934.56]
}
}
}</code></pre><p>Location names follow the format <code>db:id</code>, where <code>db</code> is the name of the database and <code>id</code> is the identifier for a specific location. RELOG currently includes the following databases:</p><table><tr><th style="text-align: left">Database</th><th style="text-align: left">Description</th><th style="text-align: left">Examples</th></tr><tr><td style="text-align: left"><code>us-state</code></td><td style="text-align: left">List of states of the United States.</td><td style="text-align: left"><code>us-state:IL</code> (State of Illinois)</td></tr><tr><td style="text-align: left"><code>2018-us-county</code></td><td style="text-align: left">List of United States counties, as of 2018. IDs are 5-digit FIPS codes.</td><td style="text-align: left"><code>2018-us-county:17043</code> (DuPage county in Illinois)</td></tr></table><h3 id="Current-limitations"><a class="docs-heading-anchor" href="#Current-limitations">Current limitations</a><a id="Current-limitations-1"></a><a class="docs-heading-anchor-permalink" href="#Current-limitations" title="Permalink"></a></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><li>Accurate driving distances are only available for the continental United States.</li></ul><h2 id="Output-Data-Format-(JSON)"><a class="docs-heading-anchor" href="#Output-Data-Format-(JSON)">Output Data Format (JSON)</a><a id="Output-Data-Format-(JSON)-1"></a><a class="docs-heading-anchor-permalink" href="#Output-Data-Format-(JSON)" title="Permalink"></a></h2><p>To be documented.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../reports/">Simplified Solution Reports »</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>
}</code></pre><p>Location names follow the format <code>db:id</code>, where <code>db</code> is the name of the database and <code>id</code> is the identifier for a specific location. RELOG currently includes the following databases:</p><table><tr><th style="text-align: left">Database</th><th style="text-align: left">Description</th><th style="text-align: left">Examples</th></tr><tr><td style="text-align: left"><code>us-state</code></td><td style="text-align: left">List of states of the United States.</td><td style="text-align: left"><code>us-state:IL</code> (State of Illinois)</td></tr><tr><td style="text-align: left"><code>2018-us-county</code></td><td style="text-align: left">List of United States counties, as of 2018. IDs are 5-digit FIPS codes.</td><td style="text-align: left"><code>2018-us-county:17043</code> (DuPage county in Illinois)</td></tr></table><h3 id="Current-limitations"><a class="docs-heading-anchor" href="#Current-limitations">Current limitations</a><a id="Current-limitations-1"></a><a class="docs-heading-anchor-permalink" href="#Current-limitations" title="Permalink"></a></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><li>Accurate driving distances are only available for the continental United States.</li></ul><h2 id="Output-Data-Format-(JSON)"><a class="docs-heading-anchor" href="#Output-Data-Format-(JSON)">Output Data Format (JSON)</a><a id="Output-Data-Format-(JSON)-1"></a><a class="docs-heading-anchor-permalink" href="#Output-Data-Format-(JSON)" title="Permalink"></a></h2><p>To be documented.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../usage/">« Usage</a><a class="docs-footer-nextpage" href="../reports/">Simplified Solution Reports »</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>