Skip to content

Commit f86ee5c

Browse files
authored
Merge pull request #444 from ConnorWelch-OSU/removing-verbosity
Reducing the verbosity of the tutorial
2 parents 9369dcb + 14d86ed commit f86ee5c

12 files changed

+193
-882
lines changed

source/user/tutorial/add_arche.rst

Lines changed: 41 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,12 @@ The ``archetype`` block is located after the simulation control block and takes
124124
125125
<archetypes>
126126
<spec>
127-
<lib>lib1</lib>
128-
<name>arch_1</name>
127+
<lib>[string]</lib>
128+
<name>[string]</name>
129129
</spec>
130130
<spec>
131-
<lib>lib2</lib>
132-
<name>arch_2</name>
131+
<lib>[string]</lib>
132+
<name>[string]</name>
133133
</spec>
134134
...
135135
</archetypes>
@@ -138,79 +138,57 @@ where ``lib`` is the library in which the archetype came from and ``name`` is
138138
the archetype name. You need one `spec` block in the archetypes section
139139
for each archetype you use in your simulation.
140140
Let's build the archetypes block in our input file.
141-
Using the template below and the table below,
141+
Using the template above and the table below,
142142
fill in the template with the variables listed in the table below.
143143

144-
+-------------+------------------+----------------------------+
145-
| Variable | Value | Purpose |
146-
+=============+==================+============================+
147-
| ``lib1`` | ``cycamore`` | Library of the archetype |
148-
+-------------+------------------+----------------------------+
149-
| ``arch1`` | ``Enrichment`` | Name of archetype |
150-
+-------------+------------------+----------------------------+
151-
| ``lib2`` | ``cycamore`` | Library of the archetype |
152-
+-------------+------------------+----------------------------+
153-
| ``arch2`` | ``Reactor`` | Name of archetype |
154-
+-------------+------------------+----------------------------+
155-
| ``lib3`` | ``cycamore`` | Library of the archetype |
156-
+-------------+------------------+----------------------------+
157-
| ``arch3`` | ``Source`` | Name of archetype |
158-
+-------------+------------------+----------------------------+
159-
| ``lib4`` | ``cycamore`` | Library of the archetype |
160-
+-------------+------------------+----------------------------+
161-
| ``arch4`` | ``Sink`` | Name of archetype |
162-
+-------------+------------------+----------------------------+
163-
164-
165-
Archetype Block Template
166-
------------------------
144+
+-------------+-------------+------------------+
145+
| Archetype # | Variable | Value |
146+
+=============+=============+==================+
147+
| 1 | ``lib`` | ``cycamore`` |
148+
+ +-------------+------------------+
149+
| | ``name`` | ``Source`` |
150+
+-------------+-------------+------------------+
151+
| 2 | ``lib`` | ``cycamore`` |
152+
+ +-------------+------------------+
153+
| | ``name`` | ``Enrichment`` |
154+
+-------------+-------------+------------------+
155+
| 3 | ``lib`` | ``cycamore`` |
156+
+ +-------------+------------------+
157+
| | ``name`` | ``Reactor`` |
158+
+-------------+-------------+------------------+
159+
| 4 | ``lib`` | ``cycamore`` |
160+
+ +-------------+------------------+
161+
| | ``name`` | ``Sink`` |
162+
+-------------+-------------+------------------+
163+
164+
The order of the archetypes in this block is of no consequence. Once complete, append the archetypes section under the control section of input file [#f1]_.
165+
166+
Check: Complete Archetypes block
167+
+++++++++++++++++++++++++++++++++++++++
168+
169+
The archetypes section of your input file should now look like:
170+
167171
.. code-block:: XML
168172
169-
<archetypes>
173+
<archetypes>
170174
<spec>
171-
<lib>lib1</lib>
172-
<name>arch1</name>
175+
<lib>cycamore</lib>
176+
<name>Enrichment</name>
173177
</spec>
174178
<spec>
175-
<lib>lib2</lib>
176-
<name>arch2</name>
179+
<lib>cycamore</lib>
180+
<name>Reactor</name>
177181
</spec>
178182
<spec>
179-
<lib>lib3</lib>
180-
<name>arch3</name>
183+
<lib>cycamore</lib>
184+
<name>Source</name>
181185
</spec>
182186
<spec>
183-
<lib>lib4</lib>
184-
<name>arch4</name>
187+
<lib>cycamore</lib>
188+
<name>Sink</name>
185189
</spec>
186-
</archetypes>
187-
188-
189-
Once complete, your ``archetypes`` block should look like:
190-
191-
.. code-block:: XML
192-
193-
<archetypes>
194-
<spec>
195-
<lib>cycamore</lib>
196-
<name>Enrichment</name>
197-
</spec>
198-
<spec>
199-
<lib>cycamore</lib>
200-
<name>Reactor</name>
201-
</spec>
202-
<spec>
203-
<lib>cycamore</lib>
204-
<name>Source</name>
205-
</spec>
206-
<spec>
207-
<lib>cycamore</lib>
208-
<name>Sink</name>
209-
</spec>
210190
</archetypes>
211191
212-
The order of the archetypes in this block is of no consequence. Once complete, append the archetypes section under the control section of input file [#f1]_.
213-
214192
.. rubric:: Footnotes
215193

216194
.. [#f1] The exact order of the sections in a |Cyclus| input file are of minor consequence. The ``control`` sequence must go first, but the other sequences can go in any order that makes sense to the user. The traditional organization of an input file is: control, archetypes, commodities, facilities, regions/institutions, and recipes.

source/user/tutorial/add_arche_commod_recipe.rst

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,6 @@ We will need two additional archetypes:
1212
1. Add the ``Cycamore::FuelFab`` archetype
1313
2. Add the ``Cycamore::Separations`` archetype
1414

15-
Activity: Adding Commodities
16-
-----------------------------
17-
18-
We will need 4 additional commodities:
19-
20-
1. fresh_mox
21-
2. used_mox
22-
3. Separated_Fissile
23-
4. Separated_Waste
24-
2515
Activity: Adding Recipes
2616
--------------------------
2717

0 commit comments

Comments
 (0)