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

Add units to input and output files; bump version to 0.2.0

Browse Source
This commit is contained in:
Alinson S. Xavier
2020-06-05 15:38:34 -05:00
parent b8cf6537a0
commit 0fc64085a8
14 changed files with 601 additions and 1115 deletions
Download Patch File Download Diff File Expand all files Collapse all files

126
docs/model/index.html
View File

@@ -154,21 +154,21 @@
</thead>
<tbody>
<tr>
<td align="left"><code>time periods</code></td>
<td>Number of time periods in the simulation.</td>
<td align="left"><code>Time horizon (years)</code></td>
<td>Number of years in the simulation.</td>
</tr>
</tbody>
</table>
<h3 id="example">Example</h3>
<pre><code class="json">{
&quot;parameters&quot;: {
&quot;time periods&quot;: 2
&quot;Parameters&quot;: {
&quot;Time horizon (years)&quot;: 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>
<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>
@@ -178,11 +178,11 @@
</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>
<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>initial amounts</code></td>
<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>
@@ -197,57 +197,57 @@
</thead>
<tbody>
<tr>
<td align="left"><code>latitude</code></td>
<td>The latitude of the location, in degrees.</td>
<td align="left"><code>Latitude (deg)</code></td>
<td>The latitude of the location.</td>
</tr>
<tr>
<td align="left"><code>longitude</code></td>
<td>The longitude of the location, in degrees.</td>
<td align="left"><code>Longitude (deg)</code></td>
<td>The longitude of the location.</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>
<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>
<h3 id="example_1">Example</h3>
<pre><code class="json">{
&quot;products&quot;: {
&quot;Products&quot;: {
&quot;P1&quot;: {
&quot;transportation cost&quot;: [0.015, 0.015],
&quot;initial amounts&quot;: {
&quot;Transportation cost ($/km/tonne)&quot;: [0.015, 0.015],
&quot;Initial amounts&quot;: {
&quot;C1&quot;: {
&quot;latitude&quot;: 7.0,
&quot;longitude&quot;: 7.0,
&quot;amount&quot;: [934.56, 934.56]
&quot;Latitude (deg)&quot;: 7.0,
&quot;Longitude (deg)&quot;: 7.0,
&quot;Amount (tonne)&quot;: [934.56, 934.56]
},
&quot;C2&quot;: {
&quot;latitude&quot;: 7.0,
&quot;longitude&quot;: 19.0,
&quot;amount&quot;: [198.95, 198.95]
&quot;Latitude (deg)&quot;: 7.0,
&quot;Longitude (deg)&quot;: 19.0,
&quot;Amount (tonne)&quot;: [198.95, 198.95]
},
&quot;C3&quot;: {
&quot;latitude&quot;: 84.0,
&quot;longitude&quot;: 76.0,
&quot;amount&quot;: [212.97, 212.97]
&quot;Latitude (deg)&quot;: 84.0,
&quot;Longitude (deg)&quot;: 76.0,
&quot;Amount (tonne)&quot;: [212.97, 212.97]
}
}
},
&quot;P2&quot;: {
&quot;transportation cost&quot;: [0.02, 0.02]
&quot;Transportation cost ($/km/tonne)&quot;: [0.02, 0.02]
},
&quot;P3&quot;: {
&quot;transportation cost&quot;: [0.0125, 0.0125]
&quot;Transportation cost ($/km/tonne)&quot;: [0.0125, 0.0125]
},
&quot;P4&quot;: {
&quot;transportation cost&quot;: [0.0175, 0.0175]
&quot;Transportation cost ($/km/tonne)&quot;: [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>
<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>
@@ -257,15 +257,15 @@
</thead>
<tbody>
<tr>
<td align="left"><code>input</code></td>
<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 align="left"><code>Outputs (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>locations</code></td>
<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>
@@ -280,19 +280,19 @@
</thead>
<tbody>
<tr>
<td align="left"><code>latitude</code></td>
<td align="left"><code>Latitude (deg)</code></td>
<td>The latitude of the location, in degrees.</td>
</tr>
<tr>
<td align="left"><code>longitude</code></td>
<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 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 align="left"><code>Capacities (tonne)</code></td>
<td>A dictionary describing what plant sizes are allowed, and their characteristics.</td>
</tr>
</tbody>
@@ -307,12 +307,12 @@
</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>
<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</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>
<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>
@@ -326,48 +326,48 @@
</thead>
<tbody>
<tr>
<td align="left"><code>opening cost</code></td>
<td>The cost (in dollars) to open a plant of this size.</td>
<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 (in dollars) to keep the plant open, even if the plant doesn't process anything. Must be a timeseries.</td>
<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</code></td>
<td>The cost (in dollars per tonnes) that the plant incurs to process each tonne of input. Must be a timeseries.</td>
<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>
<h3 id="example_2">Example</h3>
<pre><code class="json">{
&quot;plants&quot;: {
&quot;Plants&quot;: {
&quot;F1&quot;: {
&quot;input&quot;: &quot;P1&quot;,
&quot;outputs&quot;: {
&quot;Input&quot;: &quot;P1&quot;,
&quot;Outputs (tonne)&quot;: {
&quot;P2&quot;: 0.2,
&quot;P3&quot;: 0.5
},
&quot;locations&quot;: {
&quot;Locations&quot;: {
&quot;L1&quot;: {
&quot;latitude&quot;: 0.0,
&quot;longitude&quot;: 0.0,
&quot;disposal&quot;: {
&quot;Latitude (deg)&quot;: 0.0,
&quot;Longitude (deg)&quot;: 0.0,
&quot;Disposal&quot;: {
&quot;P2&quot;: {
&quot;cost&quot;: [-10.0, -12.0],
&quot;limit&quot;: [1.0, 1.0]
&quot;Cost ($/tonne)&quot;: [-10.0, -12.0],
&quot;Limit (tonne)&quot;: [1.0, 1.0]
}
},
&quot;capacities&quot;: {
&quot;Capacities (tonne)&quot;: {
&quot;100&quot;: {
&quot;opening cost&quot;: [500, 530],
&quot;fixed operating cost&quot;: [300.0, 310.0],
&quot;variable operating cost&quot;: [5.0, 5.2]
&quot;Opening cost ($)&quot;: [500, 530],
&quot;Fixed operating cost ($)&quot;: [300.0, 310.0],
&quot;Variable operating cost ($/tonne)&quot;: [5.0, 5.2]
},
&quot;500&quot;: {
&quot;opening cost&quot;: [750, 760],
&quot;fixed operating cost&quot;: [400.0, 450.0],
&quot;variable operating cost&quot;: [5.0, 5.2]
&quot;Opening cost ($)&quot;: [750, 760],
&quot;Fixed operating cost ($)&quot;: [400.0, 450.0],
&quot;Variable operating cost ($/tonne)&quot;: [5.0, 5.2]
}
}
}