Skip to content

Commit ea3f803

Browse files
committed
changes per cyclus#427, make things consistent
1 parent 7afe45d commit ea3f803

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

source/user/tutorial/add_deploy.rst

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Deploying New Facilities
22
==========================
33

44
Often in fuel cycle analysis, transition scenarios are considered. These ask
5-
questins like: "How does the
6-
commissioning and decommissioning of reactors affect electrity production or
5+
questions like: "How does the
6+
commissioning and decommissioning of reactors affect electricity production or
77
material transactions?". Transition analysis will
88
require an institution that can deploy additional facilities at given time
99
steps: the ``cycamore DeployInst`` archetype. This is the simplest institution
@@ -12,7 +12,8 @@ new facilities, in which the user simply defines the times at which new agents
1212
should be deployed as copies of available prototypes.
1313

1414
In this case, we will keep the current institutions and add another
15-
institution that will deploy more facilities over time.
15+
institution that will deploy more facilities over time, which can be used
16+
to meet a growing electricity demand in a simulation.
1617

1718
Example: DeployInst
1819
--------------------------------
@@ -66,27 +67,27 @@ We will now use this to add the institution for ``DeployInst``.
6667
6768
where:
6869

69-
* prototype: Ordered list of prototypes to build
70+
* prototypes: Ordered list of prototypes to build
7071
* build_times: Time step on which to deploy agents given in prototype list
7172
* n_build: Number of each prototype given in prototype list to build
7273

7374
Activity: Add a New Institution
74-
++++++++++++++++++++++++++++++++++++++++++
75+
--------------------------------
7576

7677
Using the table below and the DeployInst template above, fill out the commodities
7778
template.
7879

79-
+-------------+-------------+---------------------+
80+
+-----------------------+-------------+-----------+
8081
| Prototype | build_times | n_build |
81-
+=============+=============+=====================+
82+
+=======================+=============+===========+
8283
| UraniumMine | 1 | 1 |
83-
+-------------+-------------+---------------------+
84+
+-----------------------+-------------+-----------+
8485
| FuelFab | 1 | 1 |
85-
+-------------+-------------+---------------------+
86+
+-----------------------+-------------+-----------+
8687
| 1178MWe BRAIDWOOD_1 | 2 | 1 |
87-
+-------------+-------------+---------------------+
88+
+-----------------------+-------------+-----------+
8889
| 1000MWe LIGHTWATER_1 | 3 | 1 |
89-
+-------------+-------------+---------------------+
90+
+-----------------------+-------------+-----------+
9091

9192
Using the prototype facilities already created, the new institution should
9293
look like the following:
@@ -121,16 +122,16 @@ look like the following:
121122
</config>
122123
</institution>
123124
124-
The above institution will create 1 ``UraniumMine`` and 1 ``FuelFab`` facility on
125+
The above institution will deploy 1 ``UraniumMine`` and 1 ``FuelFab`` facility on
125126
time step 1. The next time step will deploy the ``1178MWe BRAIDWOOD_1`` reactor
126127
prototype. And finally, at time step 3, the ``1000We LIGHTWATER_1`` will be deployed.
127128
This institution block goes inside the Region block, with the previously created
128-
insitutions blocks.
129+
institution blocks.
129130

130-
**ExampleInstitution** is a placeholder for your institution name, and in this scenario
131+
``ExampleInstitution`` is a placeholder for your institution name, and in this scenario
131132
only one of each prototype will be deployed since ``n_build`` has a value of 1 for each.
132133

133134
This example is now complete. Save your file as the desired file name (with ``.xml``
134135
extension) and run your code through |Cyclus|. If your simulation runs into errors,
135136
sample files can be found `here <https://doi.org/10.5281/zenodo.4557613>`_ under
136-
``input_deployinst.xml`` or ``ouput_deployinst.sqlite``.
137+
``input_deployinst.xml`` or ``output_deployinst.sqlite``.

0 commit comments

Comments
 (0)