Skip to content

Reducing the verbosity of the tutorial #444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ConnorWelch-OSU wants to merge 21 commits into
base: source
Choose a base branch
from
Open

Reducing the verbosity of the tutorial #444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
b031885
remove step by step instruction in activity
ConnorWelch-OSU Jan 27, 2026
0c12781
remove archetype block template and check
ConnorWelch-OSU Jan 27, 2026
b81e7bd
remove step by step instructions for commodity and recipe activities
ConnorWelch-OSU Jan 27, 2026
0613e54
remove excess code blocks from activities
ConnorWelch-OSU Jan 27, 2026
0838201
remove extra region template and step by step for second institution
ConnorWelch-OSU Jan 27, 2026
2b1bdd8
make activity instruction match context
ConnorWelch-OSU Jan 27, 2026
26bba24
add missing check sections
ConnorWelch-OSU Jan 29, 2026
fe2e81a
Update source/user/tutorial/add_reg_inst.rst
ConnorWelch-OSU Jan 29, 2026
0289a21
improve wording for second inst activity
ConnorWelch-OSU Jan 29, 2026
af59e01
change archetype activity table
ConnorWelch-OSU Feb 4, 2026
fe8b3b9
add reference to add_arche in add_reg_inst
ConnorWelch-OSU Feb 4, 2026
ecff641
update agents archetype table
ConnorWelch-OSU Feb 5, 2026
e6d25bd
made order of archetypes consistent
ConnorWelch-OSU Feb 5, 2026
cca9bb9
remove commodity block from input files
ConnorWelch-OSU Feb 5, 2026
cce6d37
remove add commodity activity
ConnorWelch-OSU Feb 5, 2026
a54c5f4
remove references to commodity section
ConnorWelch-OSU Feb 5, 2026
1963945
fix code block and table formatting
ConnorWelch-OSU Feb 5, 2026
cc07c94
remove commodity block references from later scenarios
ConnorWelch-OSU Feb 5, 2026
08fbcda
remove commodity blocks from recap
ConnorWelch-OSU Feb 5, 2026
071aad1
remove commodity from check section
ConnorWelch-OSU Feb 6, 2026
c9cf153
fix undestanding archetypes link
ConnorWelch-OSU Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 41 additions & 63 deletions source/user/tutorial/add_arche.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,12 +124,12 @@ The ``archetype`` block is located after the simulation control block and takes

<archetypes>
<spec>
<lib>lib1</lib>
<name>arch_1</name>
<lib>[string]</lib>
<name>[string]</name>
</spec>
<spec>
<lib>lib2</lib>
<name>arch_2</name>
<lib>[string]</lib>
<name>[string]</name>
</spec>
...
</archetypes>
Expand All @@ -138,79 +138,57 @@ where ``lib`` is the library in which the archetype came from and ``name`` is
the archetype name. You need one `spec` block in the archetypes section
for each archetype you use in your simulation.
Let's build the archetypes block in our input file.
Using the template below and the table below,
Using the template above and the table below,
fill in the template with the variables listed in the table below.

+-------------+------------------+----------------------------+
| Variable | Value | Purpose |
+=============+==================+============================+
| ``lib1`` | ``cycamore`` | Library of the archetype |
+-------------+------------------+----------------------------+
| ``arch1`` | ``Enrichment`` | Name of archetype |
+-------------+------------------+----------------------------+
| ``lib2`` | ``cycamore`` | Library of the archetype |
+-------------+------------------+----------------------------+
| ``arch2`` | ``Reactor`` | Name of archetype |
+-------------+------------------+----------------------------+
| ``lib3`` | ``cycamore`` | Library of the archetype |
+-------------+------------------+----------------------------+
| ``arch3`` | ``Source`` | Name of archetype |
+-------------+------------------+----------------------------+
| ``lib4`` | ``cycamore`` | Library of the archetype |
+-------------+------------------+----------------------------+
| ``arch4`` | ``Sink`` | Name of archetype |
+-------------+------------------+----------------------------+


Archetype Block Template
------------------------
+-------------+-------------+------------------+
| Archetype # | Variable | Value |
+=============+=============+==================+
| 1 | ``lib`` | ``cycamore`` |
+ +-------------+------------------+
| | ``arch`` | ``Source`` |
Copy link
Member

@gonuke gonuke Feb 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no variable named "arch" - can we change this to "name"?

+-------------+-------------+------------------+
| 2 | ``lib`` | ``cycamore`` |
+ +-------------+------------------+
| | ``arch`` | ``Enrichment`` |
+-------------+-------------+------------------+
| 3 | ``lib`` | ``cycamore`` |
+ +-------------+------------------+
| | ``arch`` | ``Reactor`` |
+-------------+-------------+------------------+
| 4 | ``lib`` | ``cycamore`` |
+ +-------------+------------------+
| | ``arch`` | ``Sink`` |
+-------------+-------------+------------------+

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]_.

Check: Complete Archetypes block
+++++++++++++++++++++++++++++++++++++++

The archetypes section of your input file should now look like:

.. code-block:: XML

<archetypes>
<archetypes>
<spec>
<lib>lib1</lib>
<name>arch1</name>
<lib>cycamore</lib>
<name>Enrichment</name>
</spec>
<spec>
<lib>lib2</lib>
<name>arch2</name>
<lib>cycamore</lib>
<name>Reactor</name>
</spec>
<spec>
<lib>lib3</lib>
<name>arch3</name>
<lib>cycamore</lib>
<name>Source</name>
</spec>
<spec>
<lib>lib4</lib>
<name>arch4</name>
<lib>cycamore</lib>
<name>Sink</name>
</spec>
</archetypes>


Once complete, your ``archetypes`` block should look like:

.. code-block:: XML

<archetypes>
<spec>
<lib>cycamore</lib>
<name>Enrichment</name>
</spec>
<spec>
<lib>cycamore</lib>
<name>Reactor</name>
</spec>
<spec>
<lib>cycamore</lib>
<name>Source</name>
</spec>
<spec>
<lib>cycamore</lib>
<name>Sink</name>
</spec>
</archetypes>

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]_.

.. rubric:: Footnotes

.. [#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.
10 changes: 0 additions & 10 deletions source/user/tutorial/add_arche_commod_recipe.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,6 @@ We will need two additional archetypes:
1. Add the ``Cycamore::FuelFab`` archetype
2. Add the ``Cycamore::Separations`` archetype

Activity: Adding Commodities
-----------------------------

We will need 4 additional commodities:

1. fresh_mox
2. used_mox
3. Separated_Fissile
4. Separated_Waste

Activity: Adding Recipes
--------------------------

Expand Down
Loading