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:
@@ -140,6 +140,8 @@
|
||||
<li class="second-level"><a href="#plant-emissions-report">Plant emissions report</a></li>
|
||||
|
||||
<li class="third-level"><a href="#sample-charts_2">Sample charts</a></li>
|
||||
<li class="second-level"><a href="#products-report">Products report</a></li>
|
||||
|
||||
<li class="second-level"><a href="#transportation-report">Transportation report</a></li>
|
||||
|
||||
<li class="third-level"><a href="#sample-charts_3">Sample charts</a></li>
|
||||
@@ -154,8 +156,7 @@
|
||||
<p>In addition to the full output format described in <a href="../format/">data formats</a>, RELOG can also generate a number of simplified reports in tabular data format (CSV), which can be more easily processed by spreadsheet software (such as Microsoft Excel), by data analysis libraries (such as Pandas) or by relational databases (such as SQLite).</p>
|
||||
<p>In this page, we also illustrate what types of charts and visualizations can be produced from these tabular data files. The sample charts have been produced using Python, matplotlib, seaborn and geopandas.</p>
|
||||
<h2 id="plants-report">Plants report</h2>
|
||||
<p>Report showing plant costs, capacities, energy expenditure and utilization factors.</p>
|
||||
<p>Generated by <code>RELOG.write_plants_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_plants.csv">nimh_plants.csv</a>.</p>
|
||||
<p>Report showing plant costs, capacities, energy expenditure and utilization factors. Generated by <code>RELOG.write_plants_report(solution, filename)</code>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -174,7 +175,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>year</code></td>
|
||||
<td>What year this row corresponds to. This reports includes one row for each year in the simulation.</td>
|
||||
<td>What year this row corresponds to. This reports includes one row for each year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>latitude (deg)</code></td>
|
||||
@@ -270,8 +271,7 @@ gp.GeoDataFrame(data, geometry=points).plot(ax=ax);
|
||||
</code></pre>
|
||||
<p><img src="../images/ex_plant_locations.png" width="1000px"/></p>
|
||||
<h2 id="plant-outputs-report">Plant outputs report</h2>
|
||||
<p>Report showing amount of products produced, sent and disposed of by each plant, as well as disposal costs.</p>
|
||||
<p>Generated by <code>RELOG.write_plant_outputs_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_plant_outputs.csv">nimh_plant_outputs.csv</a>.</p>
|
||||
<p>Report showing amount of products produced, sent and disposed of by each plant, as well as disposal costs. Generated by <code>RELOG.write_plant_outputs_report(solution, filename)</code>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -290,7 +290,7 @@ gp.GeoDataFrame(data, geometry=points).plot(ax=ax);
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>year</code></td>
|
||||
<td>What year this row corresponds to. This reports includes one row for each year in the simulation.</td>
|
||||
<td>What year this row corresponds to. This reports includes one row for each year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>product name</code></td>
|
||||
@@ -331,8 +331,7 @@ sns.barplot(x="amount produced (tonne)",
|
||||
</code></pre>
|
||||
<p><img src="../images/ex_amount_produced.png" width="500px"/></p>
|
||||
<h2 id="plant-emissions-report">Plant emissions report</h2>
|
||||
<p>Report showing amount of emissions produced by each plant.</p>
|
||||
<p>Generated by <code>RELOG.write_plant_emissions_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_plant_emissions.csv">nimh_plant_emissions.csv</a>.</p>
|
||||
<p>Report showing amount of emissions produced by each plant. Generated by <code>RELOG.write_plant_emissions_report(solution, filename)</code>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -379,9 +378,48 @@ sns.barplot(x="plant type",
|
||||
.reset_index());
|
||||
</code></pre>
|
||||
<p><img src="../images/ex_emissions.png" width="500px"/></p>
|
||||
<h2 id="products-report">Products report</h2>
|
||||
<p>Report showing primary product amounts, locations and marginal costs. Generated by <code>RELOG.write_products_report(solution, filename)</code>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Column</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>product name</code></td>
|
||||
<td>Product name.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>location name</code></td>
|
||||
<td>Name of the collection center.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>latitude (deg)</code></td>
|
||||
<td>Latitude of the collection center.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>longitude (deg)</code></td>
|
||||
<td>Longitude of the collection center.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>year</code></td>
|
||||
<td>What year this row corresponds to. This reports includes one row for each year.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>amount (tonne)</code></td>
|
||||
<td>Amount of product available at this collection center.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>marginal cost ($/tonne)</code></td>
|
||||
<td>Cost to process one additional tonne of this product coming from this collection center.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="transportation-report">Transportation report</h2>
|
||||
<p>Report showing amount of product sent from initial locations to plants, and from one plant to another. Includes the distance between each pair of locations, amount-distance shipped, transportation costs and energy expenditure.</p>
|
||||
<p>Generated by <code>RELOG.write_transportation_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_transportation.csv">nimh_transportation.csv</a>.</p>
|
||||
<p>Report showing amount of product sent from initial locations to plants, and from one plant to another. Includes the distance between each pair of locations, amount-distance shipped, transportation costs and energy expenditure. Generated by <code>RELOG.write_transportation_report(solution, filename)</code>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
@@ -510,8 +548,7 @@ gp.GeoDataFrame(data, geometry=points).plot(ax=ax,
|
||||
</code></pre>
|
||||
<p><img src="../images/ex_transportation.png" width="1000px"/></p>
|
||||
<h2 id="transportation-emissions-report">Transportation emissions report</h2>
|
||||
<p>Report showing emissions for each trip between initial locations and plants, and between pairs of plants.</p>
|
||||
<p>Generated by <code>RELOG.write_transportation_emissions_report(solution, filename)</code>. For a concrete example, see <a href="https://github.com/ANL-CEEESA/RELOG/blob/master/test/fixtures/nimh_transportation_emissions.csv">nimh_transportation_emissions.csv</a>.</p>
|
||||
<p>Report showing emissions for each trip between initial locations and plants, and between pairs of plants. Generated by <code>RELOG.write_transportation_emissions_report(solution, filename)</code>.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
Reference in New Issue
Block a user