Skip to content

Commit 37f678d

Browse files
committed
ange reg/inst names, clarify region block format
1 parent c8c389d commit 37f678d

File tree

1 file changed

+31
-11
lines changed

1 file changed

+31
-11
lines changed

source/user/tutorial/add_reg_inst.rst

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -110,17 +110,19 @@ results in the full archetype block:
110110
Concept: Regions
111111
----------------
112112

113-
Regions tie together a fuel cycle as they designate what facilities are
113+
Regions tie together a fuel cycle as they designate what institutions and facilities are
114114
in the region's fuel cycle. Regions may apply preferences to each
115115
potential request-bid pairing based on the proposed resource transfer.
116-
The basic structure of the ``NullRegion`` is:
116+
The basic structure of a region block is:
117117

118118
.. code-block:: XML
119119
120120
<region>
121121
<name>Region_name</name>
122122
<config>
123-
<NullRegion/>
123+
<RegionArchetype>
124+
...
125+
<RegionArchetype>
124126
</config>
125127
<institution>
126128
...
@@ -133,10 +135,28 @@ Where:
133135

134136
* ``name``: name of the region
135137
* ``config``: Region archetype to use
138+
* ``RegionArchetype``: name of the Region archetype you wish to use in your simulation, and the dotted line in this section represents any inputs that the archetype might have.
139+
136140

137141
In between the two dotted lines
138142
is where the institution and facility information goes.
139143

144+
In this example, we will use the ``NullRegion`` archetype, which does not have any inputs. Filling this into our region block template, we get:
145+
146+
.. code-block:: XML
147+
148+
<region>
149+
<name>Region_name</name>
150+
<config>
151+
<NullRegion/>
152+
</config>
153+
<institution>
154+
...
155+
...
156+
</institution>
157+
158+
</region>
159+
140160
Concept: Institutions
141161
-----------------------------------------------------------------------
142162
In |Cyclus| input files, each institution controls the deployment of
@@ -339,27 +359,27 @@ Save your input file as ``cyclus_intro_file.xml``
339359
Activity: Add an extra institution into the Region
340360
-------------------------------------------------
341361
Having multiple institutions help organize facilities and their affiliation.
342-
In our ``USA`` region, let's add a second institution called ``Exelon``.
343-
``Exelon`` is the institution that holds the ``1178MWe BRAIDWOOD_1`` prototype and ``United
362+
In our ``USA`` region, let's add a second institution called ``ReactorUtility``.
363+
``ReactorUtility`` is the institution that holds the ``1178MWe ReactorPlant Unit 1`` prototype and ``United
344364
States Nuclear`` holds the ``UraniumMine``, ``EnrichmentPlant``, and ``NuclearRepository``
345365
prototypes.
346366

347367
.. image:: RIF_tutorial.png
348368

349369
Using the template above and the table below, let's build the region.
350370

351-
1. Let's build the ``Exelon`` institution. This institution has one ``1178MWe BRAIDWOOD_1`` prototype. Using this information we can write this institution as:
371+
1. Let's build the ``ReactorUtility`` institution. This institution has one ``1178MWe ReactorPlant Unit 1`` prototype. Using this information we can write this institution as:
352372

353373
.. code-block:: XML
354374
355375
<institution>
356376
<initialfacilitylist>
357377
<entry>
358-
<prototype>1178MWe BRAIDWOOD_1</prototype>
378+
<prototype>1178MWe ReactorPlant Unit 1</prototype>
359379
<number>1</number>
360380
</entry>
361381
</initialfacilitylist>
362-
<name>Exelon</name>
382+
<name>ReactorUtility</name>
363383
<config>
364384
<NullInst/>
365385
</config>
@@ -400,7 +420,7 @@ Using the template above and the table below, let's build the region.
400420
401421
</region>
402422
403-
3. We will add the ``Exelon`` institution into the blank lines of our ``USA`` region
423+
3. We will add the ``ReactorUtility`` institution into the blank lines of our ``USA`` region
404424
block. Once complete, your region prototype should look like:
405425

406426
.. code-block:: XML
@@ -434,11 +454,11 @@ Using the template above and the table below, let's build the region.
434454
<institution>
435455
<initialfacilitylist>
436456
<entry>
437-
<prototype>1178MWe BRAIDWOOD_1</prototype>
457+
<prototype>1178MWe ReactorPlant Unit 1</prototype>
438458
<number>1</number>
439459
</entry>
440460
</initialfacilitylist>
441-
<name>Exelon</name>
461+
<name>ReactorUtility</name>
442462
<config>
443463
<NullInst/>
444464
</config>

0 commit comments

Comments
 (0)