You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/user/tutorial/add_reg_inst.rst
+31-11Lines changed: 31 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,17 +110,19 @@ results in the full archetype block:
110
110
Concept: Regions
111
111
----------------
112
112
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
114
114
in the region's fuel cycle. Regions may apply preferences to each
115
115
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:
117
117
118
118
.. code-block:: XML
119
119
120
120
<region>
121
121
<name>Region_name</name>
122
122
<config>
123
-
<NullRegion/>
123
+
<RegionArchetype>
124
+
...
125
+
<RegionArchetype>
124
126
</config>
125
127
<institution>
126
128
...
@@ -133,10 +135,28 @@ Where:
133
135
134
136
* ``name``: name of the region
135
137
* ``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
+
136
140
137
141
In between the two dotted lines
138
142
is where the institution and facility information goes.
139
143
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:
In |Cyclus| input files, each institution controls the deployment of
@@ -339,27 +359,27 @@ Save your input file as ``cyclus_intro_file.xml``
339
359
Activity: Add an extra institution into the Region
340
360
-------------------------------------------------
341
361
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
344
364
States Nuclear`` holds the ``UraniumMine``, ``EnrichmentPlant``, and ``NuclearRepository``
345
365
prototypes.
346
366
347
367
.. image:: RIF_tutorial.png
348
368
349
369
Using the template above and the table below, let's build the region.
350
370
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:
352
372
353
373
.. code-block:: XML
354
374
355
375
<institution>
356
376
<initialfacilitylist>
357
377
<entry>
358
-
<prototype>1178MWe BRAIDWOOD_1</prototype>
378
+
<prototype>1178MWe ReactorPlant Unit 1</prototype>
359
379
<number>1</number>
360
380
</entry>
361
381
</initialfacilitylist>
362
-
<name>Exelon</name>
382
+
<name>ReactorUtility</name>
363
383
<config>
364
384
<NullInst/>
365
385
</config>
@@ -400,7 +420,7 @@ Using the template above and the table below, let's build the region.
400
420
401
421
</region>
402
422
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
404
424
block. Once complete, your region prototype should look like:
405
425
406
426
.. code-block:: XML
@@ -434,11 +454,11 @@ Using the template above and the table below, let's build the region.
434
454
<institution>
435
455
<initialfacilitylist>
436
456
<entry>
437
-
<prototype>1178MWe BRAIDWOOD_1</prototype>
457
+
<prototype>1178MWe ReactorPlant Unit 1</prototype>
0 commit comments