mirror of
https://github.com/ANL-CEEESA/RELOG.git
synced 2025-12-06 15:48:51 -06:00
Update 0.5 docs
This commit is contained in:
@@ -136,6 +136,7 @@
|
||||
<li class="third-level"><a href="#parameters">Parameters</a></li>
|
||||
<li class="third-level"><a href="#products">Products</a></li>
|
||||
<li class="third-level"><a href="#processing-plants">Processing plants</a></li>
|
||||
<li class="third-level"><a href="#geographic-database">Geographic database</a></li>
|
||||
<li class="third-level"><a href="#current-limitations">Current limitations</a></li>
|
||||
<li class="second-level"><a href="#output-data-format-json">Output Data Format (JSON)</a></li>
|
||||
|
||||
@@ -436,6 +437,50 @@
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<h3 id="geographic-database">Geographic database</h3>
|
||||
<p>Instead of specifying locations using latitudes and longitudes, it is also possible to specify them using unique identifiers, such as the name of a US state, or the county FIPS code. This works anywhere <code>latitude (deg)</code> and <code>longitude (deg)</code> are expected. For example, instead of:</p>
|
||||
<pre><code class="language-json">{
|
||||
"initial amounts": {
|
||||
"C1": {
|
||||
"latitude (deg)": 37.27182,
|
||||
"longitude (deg)": -119.2704,
|
||||
"amount (tonne)": [934.56, 934.56]
|
||||
},
|
||||
}
|
||||
}
|
||||
</code></pre>
|
||||
<p>is is possible to write:</p>
|
||||
<pre><code class="language-json">{
|
||||
"initial amounts": {
|
||||
"C1": {
|
||||
"location": "us-state:CA",
|
||||
"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>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Database</th>
|
||||
<th>Description</th>
|
||||
<th>Examples</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>us-state</code></td>
|
||||
<td>List of states of the United States.</td>
|
||||
<td><code>us-state:IL</code> (State of Illinois)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>2018-us-county</code></td>
|
||||
<td>List of United States counties, as of 2018. IDs are 5-digit FIPS codes.</td>
|
||||
<td><code>2018-us-county:17043</code> (DuPage county in Illinois)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="current-limitations">Current limitations</h3>
|
||||
<ul>
|
||||
<li>Each plant can only be opened exactly once. After open, the plant remains open until the end of the simulation.</li>
|
||||
|
||||
Reference in New Issue
Block a user