From b0318850871ae18ce4759ecb045c9e3278d17d04 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Tue, 27 Jan 2026 11:14:47 -0800 Subject: [PATCH 01/21] remove step by step instruction in activity --- source/user/tutorial/sim_parm.rst | 36 ------------------------------- 1 file changed, 36 deletions(-) diff --git a/source/user/tutorial/sim_parm.rst b/source/user/tutorial/sim_parm.rst index 3f78cdd8..e5353e69 100644 --- a/source/user/tutorial/sim_parm.rst +++ b/source/user/tutorial/sim_parm.rst @@ -102,42 +102,6 @@ with the variables listed in the table below in your favorite text editor. | ``decay`` | ``never`` | radioactive decay | +-------------------+---------------+---------------------------------+ -Using this table, let's set the simulation parameters. - -1. To tell |Cyclus| that this is the simulation section of the input file, -first add a ``simulation`` block: - -.. code-block:: XML - - - - -2. Place the ``control`` header in as such - -.. code-block:: XML - - - - - - -Adding spaces to indent the ``control`` header improves ease of reading. - -3. After filling in the parameters listed in the table above, close the control and simulation sections as: - -.. code-block:: XML - - - - 720 - 1 - 2018 - never - - - - - **Note**: There are two blank lines between the end of the control section and end of the simulation section. This section of the simulation block will hold the rest of the simulation parameter blocks (commodities, facilities, regions, From 0c12781182730fdb0b75779680f5850315d2bf45 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Tue, 27 Jan 2026 11:19:08 -0800 Subject: [PATCH 02/21] remove archetype block template and check --- source/user/tutorial/add_arche.rst | 48 ------------------------------ 1 file changed, 48 deletions(-) diff --git a/source/user/tutorial/add_arche.rst b/source/user/tutorial/add_arche.rst index 5ecc22d1..eb723984 100644 --- a/source/user/tutorial/add_arche.rst +++ b/source/user/tutorial/add_arche.rst @@ -161,54 +161,6 @@ fill in the template with the variables listed in the table below. | ``arch4`` | ``Sink`` | Name of archetype | +-------------+------------------+----------------------------+ - -Archetype Block Template ------------------------- -.. code-block:: XML - - - - lib1 - arch1 - - - lib2 - arch2 - - - lib3 - arch3 - - - lib4 - arch4 - - - - -Once complete, your ``archetypes`` block should look like: - -.. code-block:: XML - - - - cycamore - Enrichment - - - cycamore - Reactor - - - cycamore - Source - - - cycamore - 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]_. .. rubric:: Footnotes From b81e7bd0999374455d6d75770d1a923ddbd0e4e4 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Tue, 27 Jan 2026 11:25:10 -0800 Subject: [PATCH 03/21] remove step by step instructions for commodity and recipe activities --- source/user/tutorial/add_commod_recipe.rst | 159 --------------------- 1 file changed, 159 deletions(-) diff --git a/source/user/tutorial/add_commod_recipe.rst b/source/user/tutorial/add_commod_recipe.rst index 14827347..a8e176b4 100644 --- a/source/user/tutorial/add_commod_recipe.rst +++ b/source/user/tutorial/add_commod_recipe.rst @@ -112,48 +112,6 @@ template. | com4 | tails | 1.0 | +-------------+-------------+---------------------+ -1. Let's start with ``u_ore``. In the ```` line replace ``com1`` with ``u_ore`` -inside a ``commodity`` block. - -.. code-block:: XML - - - u_ore - - -2. In the ```` section replace ``val1`` with ``1.0``. - -.. code-block:: XML - - - - u_ore - 1.0 - - - - -3. Repeat this process for the other three commodities. Your final result should look like: - -.. code-block:: XML - - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - - Once complete, append the commodities section under the archetypes section [#f1]_. Understanding Recipes @@ -244,123 +202,6 @@ template for natural uranium, fresh fuel, and spent fuel. | :math:`^{137}`\ Cs | 55137 | 0.04 | +---------------------+--------------------+--------------------+ -1. Let's start with the Natural Uranium recipe. Start by placing a ```` -block to signify that this is a recipe and tab in and place the fill -```` tag such as: - -.. code-block:: XML - - - nat_u - - -2. To signify that the composition of this recipe is in terms of Mass, fill the -```` tag with ``mass``. - -.. code-block:: XML - - - nat_u - mass - - -3. To add a nuclide to this recipe, call the ``nuclide`` tag, tab in, add the -```` and ```` tags: - -.. code-block:: XML - - - nat_u - mass - - id1 - comp1 - - - -4. We will fill the ```` tag with the uranium-235 ``Nuc Id``, ``92235``, and -fill the composition tag with its mass composition, ``0.00711``. - -.. code-block:: XML - - - nat_u - mass - - 92235 - 0.00711 - - - -5. Following the same procedure, we can add uranium-238 to this recipe such as: - -.. code-block:: XML - - - nat_u - mass - - 92235 - 0.00711 - - - 92238 - 0.99289 - - - -6. We can add other recipes in separate ``recipe`` blocks. -The recipe section of this tutorial is placed below. - -.. code-block:: XML - - - nat_u - mass - - 92235 - 0.00711 - - - 92238 - 0.99289 - - - - - fresh_uox - mass - - 92235 - 0.04 - - - 92238 - 0.96 - - - - - spent_uox - mass - - 92235 - 0.011 - - - 92238 - 0.94 - - - 94239 - 0.009 - - - 55137 - 0.04 - - - Once complete, append this facility under the commodity section of your input file [#f1]_. From 0613e549e0775cf178e2a85a8699323d2b7e519b Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Tue, 27 Jan 2026 11:40:05 -0800 Subject: [PATCH 04/21] remove excess code blocks from activities --- source/user/tutorial/add_proto.rst | 166 +++-------------------------- 1 file changed, 13 insertions(+), 153 deletions(-) diff --git a/source/user/tutorial/add_proto.rst b/source/user/tutorial/add_proto.rst index f5ce974d..cf577290 100644 --- a/source/user/tutorial/add_proto.rst +++ b/source/user/tutorial/add_proto.rst @@ -83,8 +83,7 @@ Optional parameters: Activity: Configure the Source prototype ++++++++++++++++++++++++++++++++++++++++ Our source, ``UraniumMine``, will provide the natural uranium ore for our enrichment facility. -This facility takes two inputs, ``name`` and ``outcommod``. Using the Source -Archetype and the table below, create the UraniumMine prototype. +This facility takes two inputs, ``name`` and ``outcommod``. Using the Source archetype template above and the table below, create the UraniumMine prototype. +-----------------------+---------------------------+ | Variable | Value | @@ -94,33 +93,6 @@ Archetype and the table below, create the UraniumMine prototype. | ``out_commodity | ``u_ore`` | +-----------------------+---------------------------+ -1. The template for the Source archetype is of the form: - -.. code-block:: XML - - - name - - - out_commodity - - - - -2. Filling in the variables ``name``, ``Archetype``, and ``out_commod`` as -``UraniumMine``, ``Source``, and ``u_ore`` leads to: - -.. code-block:: XML - - - UraniumMine - - - u_ore - - - - Once complete, append this facility under the commodity section and before the recipe section of your input file [#f1]_. Example: Enrichment Prototype @@ -192,25 +164,8 @@ Optional parameters: Activity: Creating the Enrichment Prototype +++++++++++++++++++++++++++++++++++++++++++ The enrichment facility, ``EnrichmentPlant`` will intake the natural ``u_ore`` -from ``UraniumMine`` and create ``fresh_uox`` and ``tails`` as its products. -The template for the Enrichment archetype is of the form: - -.. code-block:: XML - - - name - - - feed_commodity - feed_recipe - product_commodity - tails_commodity - max_feed_inventory - - - - -Using the template above and the table below, generate the input enrichment facility prototype. +from ``UraniumMine`` and create ``fresh_uox`` and ``tails`` as its products. +Using the Enrichment archetype template above and the table below, generate the input enrichment facility prototype. +-------------------------+---------------------------+ | Variable | Value | @@ -228,24 +183,6 @@ Using the template above and the table below, generate the input enrichment faci | ``max_feed_inventory`` | 1000000 | +-------------------------+---------------------------+ - -After filling in these variables, your enrichment facility prototype will look like: - -.. code-block:: XML - - - EnrichmentPlant - - - u_ore - nat_u - fresh_uox - tails - 1000000 - - - - Once complete, append this facility under the Source prototype of your input file [#f1]_. @@ -303,37 +240,6 @@ The Reactor archetype is of the form: - -There are many optional input parameters to the Cycamore Reactor archetype. -We advise exploring the `Reactor archetype documentation `_ to find them all. - -Activity: Creating the Reactor Prototype -++++++++++++++++++++++++++++++++++++++++ - -Now let's model the reactor this fuel will go through! In this simple example, -let's model a single PWR in the United States. It has a power capacity of 1178 -MWe. The template for the reactor is given below: - -.. code-block:: XML - - - name - - - in_commod1 - in_recipe1 - out_commod1 - out_recipe1 - cycle_length - refuel_length - assem_mass - n_core - n_batch - power - - - - Where: * ``fuel_incommods``: input fuel commodity -- you can list more than one by adding more ``val`` blocks @@ -347,7 +253,15 @@ Where: * ``n_assem_batch``: number of batches replaced per refueling. * ``power_cap``: amount of electricity the reactor generates. -Using the template above and the table below, create the Reactor prototype. +There are many optional input parameters to the Cycamore Reactor archetype. +We advise exploring the `Reactor archetype documentation `_ to find them all. + +Activity: Creating the Reactor Prototype +++++++++++++++++++++++++++++++++++++++++ + +Now let's model the reactor this fuel will go through! In this simple example, +let's model a single PWR in the United States. It has a power capacity of 1178 +MWe. Using the Reactor archetype template above and the table below, create the Reactor prototype. +-----------------------+-----------------------------------+ | Variable | Value | @@ -375,28 +289,6 @@ Using the template above and the table below, create the Reactor prototype. | ``power`` | ``1178`` | +-----------------------+-----------------------------------+ -Once completed, your prototype should look like: - -.. code-block:: XML - - - 1178MWe ReactorPlant Unit 1 - - - fresh_uox - fresh_uox - spent_uox - spent_uox - 18 - 1 - 33000 - 3 - 1 - 1178 - - - - Once complete, append this facility under the Enrichment facility of your input file [#f1]_. @@ -462,7 +354,7 @@ Optional parameters: Activity: Creating the Sink Prototype +++++++++++++++++++++++++++++++++++++ Our sink, ``NuclearRepository``, will store the ``spent_uox`` and ``tails`` after -their use in the fuel cycle. Using the Sink Archetype template and the table below, +their use in the fuel cycle. Using the Sink archetype template above and the table below, create the UraniumMine prototype. +-------------------------+---------------------------+ @@ -475,38 +367,6 @@ create the UraniumMine prototype. | ``input_commodity2`` | ``tails`` | +-------------------------+---------------------------+ -The sink facility archetype is: - -.. code-block:: XML - - - Sink_name - - - - input_commodity1 - input_commodity2 - - - - - -After filling in these variables, your sink facility prototype will look like: - -.. code-block:: XML - - - NuclearRepository - - - - spent_uox - tails - - - - - Once complete, append this facility under the Reactor prototype of your input file [#f1]_. Check: Complete Facility block From 0838201a6315d953396954157125d395775f68cd Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Tue, 27 Jan 2026 12:16:23 -0800 Subject: [PATCH 05/21] remove extra region template and step by step for second institution --- source/user/tutorial/add_reg_inst.rst | 94 +++------------------------ 1 file changed, 8 insertions(+), 86 deletions(-) diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index 028f1224..54f73995 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -266,41 +266,10 @@ Putting a region and institution blocks together, a complete region template is Activity: Write the Region template ----------------------------------- -Using the template below, let's create the region section of our input file. - -.. code-block:: XML - - - region_name - - - - - - - prototype1 - amount1 - - - prototype2 - amount2 - - - prototype3 - amount3 - - - institution_name - - - - - - -Now the next part of the region template is the other facilities in the +The next part of the region template is the other facilities in the region's fuel cycle. In our example, these facilities are ``UraniumMine``, ``EnrichmentPlant``, and ``NuclearRepository``. Using -the above exercise and the table below, fill out the rest of the region +the template above and the table below, fill out the rest of the region template. +-----------------------+-----------------------------+----------+ @@ -317,6 +286,8 @@ template. | ``region_name`` | ``USA`` | N/A | +-----------------------+-----------------------------+----------+ +Once complete, append this facility under the Sink prototype of your input file. + Check: Complete Region block +++++++++++++++++++++++++++++++++++ @@ -365,60 +336,11 @@ States Nuclear`` holds the ``UraniumMine``, ``EnrichmentPlant``, and ``NuclearRe prototypes. Using the region and institution templates, let's add the second institution to the region. -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: - -.. code-block:: XML - - - - - 1178MWe ReactorPlant Unit 1 - 1 - - - ReactorUtility - - - - - -1. We have our ``USA`` region block with the ``United States Nuclear`` institution. This institution has one ``UraniumMine`` prototype, ``EnrichmentPlant`` prototype, and one ``NuclearRepository`` prototype: - -.. code-block:: XML - - - USA - - - - - - - UraniumMine - 1 - - - EnrichmentPlant - 1 - - - NuclearRepository - 1 - - - United States Nuclear - - - - - - - - - +Let's build the ``ReactorUtility`` institution. This institution has one ``1178MWe ReactorPlant Unit 1`` prototype. +Using this information we can add a second institution block into our ``USA`` +region block after the ``United States Nuclear`` institution. -3. We will add the ``ReactorUtility`` institution into the blank lines of our ``USA`` region - block. Once complete, your region prototype should look like: +Once complete, your region prototype should look like: .. code-block:: XML From 2b1bdd88eefe8e500e46520dc64f86931b712f31 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Tue, 27 Jan 2026 12:37:36 -0800 Subject: [PATCH 06/21] make activity instruction match context --- source/user/tutorial/add_arche.rst | 2 +- source/user/tutorial/add_commod_recipe.rst | 6 +++--- source/user/tutorial/add_proto.rst | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/source/user/tutorial/add_arche.rst b/source/user/tutorial/add_arche.rst index eb723984..ed9eb9e6 100644 --- a/source/user/tutorial/add_arche.rst +++ b/source/user/tutorial/add_arche.rst @@ -138,7 +138,7 @@ 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. +-------------+------------------+----------------------------+ diff --git a/source/user/tutorial/add_commod_recipe.rst b/source/user/tutorial/add_commod_recipe.rst index a8e176b4..17fe43ee 100644 --- a/source/user/tutorial/add_commod_recipe.rst +++ b/source/user/tutorial/add_commod_recipe.rst @@ -165,8 +165,8 @@ Activity: Creating a Recipe ++++++++++++++++++++++++++++ -Using the tables below, fill out the recipe -template for natural uranium, fresh fuel, and spent fuel. +Using the tables below, fill out three recipe +templates for natural uranium, fresh fuel, and spent fuel. +---------------------+--------------------+--------------------+ | Natural Uranium Composition | @@ -202,7 +202,7 @@ template for natural uranium, fresh fuel, and spent fuel. | :math:`^{137}`\ Cs | 55137 | 0.04 | +---------------------+--------------------+--------------------+ -Once complete, append this facility under the commodity section of your input file [#f1]_. +Once complete, append these recipes under the commodity section of your input file [#f1]_. Let's take a look at the ``fresh_uox`` fuel recipe (note that ``-`` is an illegal character for diff --git a/source/user/tutorial/add_proto.rst b/source/user/tutorial/add_proto.rst index cf577290..34680177 100644 --- a/source/user/tutorial/add_proto.rst +++ b/source/user/tutorial/add_proto.rst @@ -355,7 +355,7 @@ Activity: Creating the Sink Prototype +++++++++++++++++++++++++++++++++++++ Our sink, ``NuclearRepository``, will store the ``spent_uox`` and ``tails`` after their use in the fuel cycle. Using the Sink archetype template above and the table below, -create the UraniumMine prototype. +create the NuclearRepository prototype. +-------------------------+---------------------------+ | Variable | Value | From 26bba245ea0e44155d13bd748f2de050f4962efe Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 29 Jan 2026 09:08:21 -0800 Subject: [PATCH 07/21] add missing check sections --- source/user/tutorial/add_arche.rst | 26 ++++++++ source/user/tutorial/add_commod_recipe.rst | 69 ++++++++++++++++++++++ source/user/tutorial/add_proto.rst | 2 +- source/user/tutorial/add_reg_inst.rst | 2 + source/user/tutorial/sim_parm.rst | 18 ++++++ 5 files changed, 116 insertions(+), 1 deletion(-) diff --git a/source/user/tutorial/add_arche.rst b/source/user/tutorial/add_arche.rst index ed9eb9e6..844b6482 100644 --- a/source/user/tutorial/add_arche.rst +++ b/source/user/tutorial/add_arche.rst @@ -163,6 +163,32 @@ fill in the template with the variables listed in the table below. 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 + + + + cycamore + Enrichment + + + cycamore + Reactor + + + cycamore + Source + + + cycamore + Sink + + + .. 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. diff --git a/source/user/tutorial/add_commod_recipe.rst b/source/user/tutorial/add_commod_recipe.rst index 17fe43ee..918552b8 100644 --- a/source/user/tutorial/add_commod_recipe.rst +++ b/source/user/tutorial/add_commod_recipe.rst @@ -214,5 +214,74 @@ names in cyclus and ``_`` should be used instead): The recipe name ``fresh_uox`` is specified, as are the isotope nuclide IDs and the corresponding mass fraction of each nuclide. The ``fresh_uox`` is composed of 4% U-235 and 96% U-238. +Check: Complete Commodity and Recipe blocks ++++++++++++++++++++++++++++++++++++++++++++++++ + +The commodity and recipe sections of you input file should now look like: + +.. code-block:: XML + + + u_ore + 1.0 + + + fresh_uox + 1.0 + + + spent_uox + 1.0 + + + tails + 1.0 + + + + nat_u + mass + + 92235 + 0.00711 + + + 92238 + 0.99289 + + + + fresh_uox + mass + + 92235 + 0.04 + + + 92238 + 0.96 + + + + spent_uox + mass + + 92235 + 0.011 + + + 92238 + 0.94 + + + 94239 + 0.009 + + + 55137 + 0.04 + + + .. 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. diff --git a/source/user/tutorial/add_proto.rst b/source/user/tutorial/add_proto.rst index 34680177..1f88e10b 100644 --- a/source/user/tutorial/add_proto.rst +++ b/source/user/tutorial/add_proto.rst @@ -372,7 +372,7 @@ Once complete, append this facility under the Reactor prototype of your input fi Check: Complete Facility block ++++++++++++++++++++++++++++++++++++++++ -The facility section of your input file should be of the form: +The facility section of your input file should now look like: .. code-block:: XML diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index 54f73995..b99102b3 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -291,6 +291,8 @@ Once complete, append this facility under the Sink prototype of your input file. Check: Complete Region block +++++++++++++++++++++++++++++++++++ +The region section og your input file should now look like: + .. code-block:: XML diff --git a/source/user/tutorial/sim_parm.rst b/source/user/tutorial/sim_parm.rst index e5353e69..e974e083 100644 --- a/source/user/tutorial/sim_parm.rst +++ b/source/user/tutorial/sim_parm.rst @@ -106,3 +106,21 @@ with the variables listed in the table below in your favorite text editor. end of the simulation section. This section of the simulation block will hold the rest of the simulation parameter blocks (commodities, facilities, regions, institutions, and recipe blocks). + +Check: Complete Control block ++++++++++++++++++++++++++++++++ + +The control section of your input file should now look like: + +.. code-block:: XML + + + + 720 + 1 + 2018 + never + + + + From fe2e81af4bc17b1a4484b9531b82141257a60c78 Mon Sep 17 00:00:00 2001 From: Connor Welch Date: Thu, 29 Jan 2026 12:49:03 -0800 Subject: [PATCH 08/21] Update source/user/tutorial/add_reg_inst.rst typo fix Co-authored-by: meg-krieg --- source/user/tutorial/add_reg_inst.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index b99102b3..a4e4a091 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -291,7 +291,7 @@ Once complete, append this facility under the Sink prototype of your input file. Check: Complete Region block +++++++++++++++++++++++++++++++++++ -The region section og your input file should now look like: +The region section of your input file should now look like: .. code-block:: XML From 0289a21b563c9f9ef679230c370c467e65aab58b Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 29 Jan 2026 13:19:38 -0800 Subject: [PATCH 09/21] improve wording for second inst activity --- source/user/tutorial/add_reg_inst.rst | 30 +++++++++++++-------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index a4e4a091..689ca350 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -34,13 +34,13 @@ simulation. +-------------+------------------+----------------------------+ | Variable | Value | Purpose | +=============+==================+============================+ -| ``lib6`` | ``agents`` | Library of the archetype | +| ``lib5`` | ``agents`` | Library of the archetype | +-------------+------------------+----------------------------+ -| ``arch6`` | ``NullRegion`` | Name of archetype | +| ``arch5`` | ``NullRegion`` | Name of archetype | +-------------+------------------+----------------------------+ -| ``lib7`` | ``agents`` | Library of the archetype | +| ``lib6`` | ``agents`` | Library of the archetype | +-------------+------------------+----------------------------+ -| ``arch7`` | ``NullInst`` | Name of archetype | +| ``arch6`` | ``NullInst`` | Name of archetype | +-------------+------------------+----------------------------+ .. code-block:: XML @@ -48,12 +48,12 @@ simulation. ... ... - lib6 - arch6 + lib5 + arch5 - lib7 - arch7 + lib6 + arch6 @@ -331,14 +331,12 @@ Save your input file as ``tutorial_oncethrough.xml`` Activity: Add an extra institution into the Region ------------------------------------------------- -Having multiple institutions help organize facilities and their affiliation. -In our ``USA`` region, let's add a second institution called ``ReactorUtility``. -``ReactorUtility`` is the institution that holds the ``1178MWe ReactorPlant Unit 1`` prototype and ``United -States Nuclear`` holds the ``UraniumMine``, ``EnrichmentPlant``, and ``NuclearRepository`` -prototypes. Using the region and institution templates, let's -add the second institution to the region. - -Let's build the ``ReactorUtility`` institution. This institution has one ``1178MWe ReactorPlant Unit 1`` prototype. +Having multiple institutions can help organize facilities and their affiliation. +In our ``USA`` region, we have the ``United States Nuclear`` institution that +holds the ``UraniumMine``, ``EnrichmentPlant``, and ``NuclearRepository`` +prototypes. Now let's add another institution. + +Our second institution will be called ``ReactorUtility``. This institution has one ``1178MWe ReactorPlant Unit 1`` prototype. Using this information we can add a second institution block into our ``USA`` region block after the ``United States Nuclear`` institution. From af59e01392580606041ab8f711a1107a44cbc4a5 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Wed, 4 Feb 2026 12:05:00 -0800 Subject: [PATCH 10/21] change archetype activity table --- source/user/tutorial/add_arche.rst | 46 +++++++++++++++--------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/source/user/tutorial/add_arche.rst b/source/user/tutorial/add_arche.rst index 844b6482..bb601341 100644 --- a/source/user/tutorial/add_arche.rst +++ b/source/user/tutorial/add_arche.rst @@ -124,12 +124,12 @@ The ``archetype`` block is located after the simulation control block and takes - lib1 - arch_1 + [string] + [string] - lib2 - arch_2 + [string] + [string] ... @@ -141,25 +141,25 @@ Let's build the archetypes block in our input file. 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 # | Variable | Value | ++=============+=============+==================+ +| 1 | ``lib`` | ``cycamore`` | ++ +-------------+------------------+ +| | ``arch`` | ``Enrichment`` | ++-------------+-------------+------------------+ +| 2 | ``lib`` | ``cycamore`` | ++ +-------------+------------------+ +| | ``arch`` | ``Reactor`` | ++-------------+-------------+------------------+ +| 3 | ``lib`` | ``cycamore`` | ++ +-------------+------------------+ +| | ``arch`` | ``Source`` | ++-------------+-------------+------------------+ +| 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]_. From fe8b3b90da673916e2d0aa51c3b6adf5b3192bf6 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Wed, 4 Feb 2026 12:16:23 -0800 Subject: [PATCH 11/21] add reference to add_arche in add_reg_inst --- source/user/tutorial/add_reg_inst.rst | 20 ++------------------ 1 file changed, 2 insertions(+), 18 deletions(-) diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index 689ca350..1fd3ee78 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -26,10 +26,8 @@ and institutions used in this tutorial come from the ``agents`` library, rather than the ``cycamore`` library. The ``agents`` library comes with Cyclus, and you can run ``cyclus --a`` to check that the archetypes are installed. -Using the template and table below, -properly fill the template with the variables listed in the table below. -In the template, the dots represent the archetypes already defined in the -simulation. +Using the template on the `Understanding Archetypes `_, +add entries to the Archetypes block for the variables listed in the table below. +-------------+------------------+----------------------------+ | Variable | Value | Purpose | @@ -43,20 +41,6 @@ simulation. | ``arch6`` | ``NullInst`` | Name of archetype | +-------------+------------------+----------------------------+ -.. code-block:: XML - - ... - ... - - lib5 - arch5 - - - lib6 - arch6 - - - Once complete, your ``agent`` section of the Archetypes block should be: .. code-block:: XML From ecff6410c55721bad21e5bd14fc8b69b8fecf12b Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 14:43:34 -0800 Subject: [PATCH 12/21] update agents archetype table --- source/user/tutorial/add_reg_inst.rst | 52 ++++++++++----------------- 1 file changed, 18 insertions(+), 34 deletions(-) diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index 1fd3ee78..3382bdf5 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -26,40 +26,24 @@ and institutions used in this tutorial come from the ``agents`` library, rather than the ``cycamore`` library. The ``agents`` library comes with Cyclus, and you can run ``cyclus --a`` to check that the archetypes are installed. -Using the template on the `Understanding Archetypes `_, -add entries to the Archetypes block for the variables listed in the table below. - -+-------------+------------------+----------------------------+ -| Variable | Value | Purpose | -+=============+==================+============================+ -| ``lib5`` | ``agents`` | Library of the archetype | -+-------------+------------------+----------------------------+ -| ``arch5`` | ``NullRegion`` | Name of archetype | -+-------------+------------------+----------------------------+ -| ``lib6`` | ``agents`` | Library of the archetype | -+-------------+------------------+----------------------------+ -| ``arch6`` | ``NullInst`` | Name of archetype | -+-------------+------------------+----------------------------+ - -Once complete, your ``agent`` section of the Archetypes block should be: - -.. code-block:: XML - - ... - ... - - agents - NullRegion - - - agents - NullInst - - - -Since these are all archetypes, no matter what library they're from, we must append -these two``spec`` blocks into the the archetype block that we already have. This -results in the full archetype block: +Since these are all archetypes, no matter what library they're from, we must include +them into the the Archetypes block that we already have. +Using the template on the `Understanding Archetypes `_page, +append two ``spec`` blocks into the Archetypes block for the variables listed in the table below. + ++-------------+-------------+------------------+ +| Archetype # | Variable | Value | ++=============+=============+==================+ +| 5 | ``lib`` | ``agents`` | ++ +-------------+------------------+ +| | ``arch`` | ``NullRegion`` | ++-------------+-------------+------------------+ +| 6 | ``lib`` | ``agents`` | ++ +-------------+------------------+ +| | ``arch`` | ``NullInst`` | ++-------------+-------------+------------------+ + +This results in the full Archetypes block: .. code-block:: XML From e6d25bdd668a60e2ce70dd10be1bd75de193da14 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 14:45:36 -0800 Subject: [PATCH 13/21] made order of archetypes consistent --- source/user/tutorial/add_arche.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/user/tutorial/add_arche.rst b/source/user/tutorial/add_arche.rst index bb601341..c756e944 100644 --- a/source/user/tutorial/add_arche.rst +++ b/source/user/tutorial/add_arche.rst @@ -146,15 +146,15 @@ fill in the template with the variables listed in the table below. +=============+=============+==================+ | 1 | ``lib`` | ``cycamore`` | + +-------------+------------------+ -| | ``arch`` | ``Enrichment`` | +| | ``arch`` | ``Source`` | +-------------+-------------+------------------+ | 2 | ``lib`` | ``cycamore`` | + +-------------+------------------+ -| | ``arch`` | ``Reactor`` | +| | ``arch`` | ``Enrichment`` | +-------------+-------------+------------------+ | 3 | ``lib`` | ``cycamore`` | + +-------------+------------------+ -| | ``arch`` | ``Source`` | +| | ``arch`` | ``Reactor`` | +-------------+-------------+------------------+ | 4 | ``lib`` | ``cycamore`` | + +-------------+------------------+ From cca9bb96cf7c0d15448f953766948b7429e212e1 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 15:00:25 -0800 Subject: [PATCH 14/21] remove commodity block from input files --- source/user/tutorial/input_deployinst.xml | 33 -------------------- source/user/tutorial/input_oncethrough.xml | 17 ---------- source/user/tutorial/input_recycle.xml | 33 -------------------- source/user/tutorial/input_secondreactor.xml | 17 ---------- 4 files changed, 100 deletions(-) diff --git a/source/user/tutorial/input_deployinst.xml b/source/user/tutorial/input_deployinst.xml index bf01b1ad..1a2be125 100644 --- a/source/user/tutorial/input_deployinst.xml +++ b/source/user/tutorial/input_deployinst.xml @@ -18,39 +18,6 @@ agentsNullInst - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - - - fresh_mox - 1.0 - - - used_mox - 1.0 - - - separated_fissile - 1.0 - - - separated_waste - 1.0 - - nat_u mass diff --git a/source/user/tutorial/input_oncethrough.xml b/source/user/tutorial/input_oncethrough.xml index 2c843d04..08a72145 100644 --- a/source/user/tutorial/input_oncethrough.xml +++ b/source/user/tutorial/input_oncethrough.xml @@ -15,23 +15,6 @@ agentsNullInst - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - - nat_u mass diff --git a/source/user/tutorial/input_recycle.xml b/source/user/tutorial/input_recycle.xml index f06e0931..5f3f946e 100644 --- a/source/user/tutorial/input_recycle.xml +++ b/source/user/tutorial/input_recycle.xml @@ -16,39 +16,6 @@ agentsNullRegion agentsNullInst - - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - - - fresh_mox - 1.0 - - - used_mox - 1.0 - - - separated_fissile - 1.0 - - - separated_waste - 1.0 - nat_u diff --git a/source/user/tutorial/input_secondreactor.xml b/source/user/tutorial/input_secondreactor.xml index 686bdba5..d873de6c 100644 --- a/source/user/tutorial/input_secondreactor.xml +++ b/source/user/tutorial/input_secondreactor.xml @@ -15,23 +15,6 @@ agentsNullInst - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - - nat_u mass From cce6d37fad436ed2086565a3e51ca22dfb2273d1 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 15:01:36 -0800 Subject: [PATCH 15/21] remove add commodity activity --- source/user/tutorial/add_commod_recipe.rst | 91 +--------------------- 1 file changed, 3 insertions(+), 88 deletions(-) diff --git a/source/user/tutorial/add_commod_recipe.rst b/source/user/tutorial/add_commod_recipe.rst index 918552b8..72249cf0 100644 --- a/source/user/tutorial/add_commod_recipe.rst +++ b/source/user/tutorial/add_commod_recipe.rst @@ -43,76 +43,8 @@ and provides two bids accordingly. :align: center :alt: Commodity trade flowchart -Activity: Create fuel commodities (optional) -+++++++++++++++++++++++++++++++++++++++++++++++++++++ - -Let's build ``u_ore``, ``fresh_uox``, ``spent_uox``, and ``tails``, -the four commodities available for trade in our simulation. Note that -this part is **optional**, and is only needed if the user wants -to specify the solution priority of each commodity. - -* ``u_ore`` : natural uranium that is mined -* ``tails`` : waste from the enrichment process -* ``fresh_uox``: fresh 4.0% enriched Uranium Oxide fuel that enters the reactor -* ``spent_uox``: spent uranium oxide fuel that leaves the reactor after depletion - -When |Cyclus| needs -to know the isotopic composition of a material, it looks at the recipe for that -material given in the input file. Until now, ``recipe`` has been used to -refer to fuel recipes, but the ``recipe`` section of the input file can -describe any isotopic vector (e.g. natural uranium, spent fuel, fresh fuel, or any -other material whose isotopic composition needs to be tracked.) - -The commodities section follows the ``archetype`` section -and takes the form: - -.. code-block:: XML - - - com1 - 1.0 - - - com2 - 1.0 - - - com3 - 1.0 - - - com4 - 1.0 - - -where: - -* name: name of the commodity -* solution priority: number defining the relative priority for resolution in the dynamic - resource exchange. - - We will model four commodities: u_ore, fresh_uox, spent_uox, and tails. - - -Activity: Building commodities -++++++++++++++++++++++++++++++++++++++++++ - -Using the table below and the commodities template above, fill out the commodities -template. - -+-------------+-------------+---------------------+ -| Commodity | Name | Solution Priority | -+=============+=============+=====================+ -| com1 | u_ore | 1.0 | -+-------------+-------------+---------------------+ -| com2 | fresh_uox | 1.0 | -+-------------+-------------+---------------------+ -| com3 | spent_uox | 1.0 | -+-------------+-------------+---------------------+ -| com4 | tails | 1.0 | -+-------------+-------------+---------------------+ - -Once complete, append the commodities section under the archetypes section [#f1]_. +|Cyclus| does not require commodities to be defined explicitly in the input file. +Commodities are instead defined implicitly by facilities when they choose to trade. Understanding Recipes --------------------- @@ -217,27 +149,10 @@ corresponding mass fraction of each nuclide. The ``fresh_uox`` is composed of 4% Check: Complete Commodity and Recipe blocks +++++++++++++++++++++++++++++++++++++++++++++++ -The commodity and recipe sections of you input file should now look like: +The recipe section of you input file should now look like: .. code-block:: XML - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - spent_uox - 1.0 - - - tails - 1.0 - - nat_u mass From a54c5f4e2303b3a0e7dcfde286cab1a11b1f30d5 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 15:04:59 -0800 Subject: [PATCH 16/21] remove references to commodity section --- source/user/tutorial/add_commod_recipe.rst | 2 +- source/user/tutorial/add_proto.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/user/tutorial/add_commod_recipe.rst b/source/user/tutorial/add_commod_recipe.rst index 72249cf0..24e7a2f6 100644 --- a/source/user/tutorial/add_commod_recipe.rst +++ b/source/user/tutorial/add_commod_recipe.rst @@ -134,7 +134,7 @@ templates for natural uranium, fresh fuel, and spent fuel. | :math:`^{137}`\ Cs | 55137 | 0.04 | +---------------------+--------------------+--------------------+ -Once complete, append these recipes under the commodity section of your input file [#f1]_. +Once complete, append these recipes under the archetypes section of your input file [#f1]_. Let's take a look at the ``fresh_uox`` fuel recipe (note that ``-`` is an illegal character for diff --git a/source/user/tutorial/add_proto.rst b/source/user/tutorial/add_proto.rst index 1f88e10b..82b60a7b 100644 --- a/source/user/tutorial/add_proto.rst +++ b/source/user/tutorial/add_proto.rst @@ -93,7 +93,7 @@ This facility takes two inputs, ``name`` and ``outcommod``. Using the Source arc | ``out_commodity | ``u_ore`` | +-----------------------+---------------------------+ -Once complete, append this facility under the commodity section and before the recipe section of your input file [#f1]_. +Once complete, append this facility under the archetypes section and before the recipe section of your input file [#f1]_. Example: Enrichment Prototype +++++++++++++++++++++++++++++ From 1963945f549e2a867633c500eb654d7a53a60be0 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 15:36:08 -0800 Subject: [PATCH 17/21] fix code block and table formatting --- source/user/tutorial/add_deploy.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/source/user/tutorial/add_deploy.rst b/source/user/tutorial/add_deploy.rst index 9fa5712d..1497fdfa 100644 --- a/source/user/tutorial/add_deploy.rst +++ b/source/user/tutorial/add_deploy.rst @@ -36,6 +36,7 @@ We will now use this to add the institution for ``DeployInst``. ``DeployInst`` takes the form: .. code-block:: XML + ExampleInstitution @@ -77,17 +78,17 @@ Activity: Add a New Institution Using the table below and the DeployInst template above, fill out the commodities template. -+-----------------------+-------------+-----------+ -| Prototype | build_times | n_build | -+=======================+=============+===========+ -| UraniumMine | 1 | 1 | -+-----------------------+-------------+-----------+ -| FuelFab | 1 | 1 | -+-----------------------+-------------+-----------+ -| 1178MWe ReactorPlant Unit 1 | 2 | 1 | -+-----------------------+-------------+-----------+ -| 1000MWe Lightwater_1 | 3 | 1 | -+-----------------------+-------------+-----------+ ++-----------------------------+-------------+-----------+ +| Prototype | build_times | n_build | ++=============================+=============+===========+ +| UraniumMine | 1 | 1 | ++-----------------------------+-------------+-----------+ +| FuelFab | 1 | 1 | ++-----------------------------+-------------+-----------+ +| 1178MWe ReactorPlant Unit 1 | 2 | 1 | ++-----------------------------+-------------+-----------+ +| 1000MWe Lightwater_1 | 3 | 1 | ++-----------------------------+-------------+-----------+ Using the prototype facilities already created, the new institution should look like the following: From cc07c940bebdae48dd9335c0c3350fb21ff2996d Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 15:42:31 -0800 Subject: [PATCH 18/21] remove commodity block references from later scenarios --- source/user/tutorial/add_arche_commod_recipe.rst | 10 ---------- source/user/tutorial/add_deploy.rst | 3 +-- 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/source/user/tutorial/add_arche_commod_recipe.rst b/source/user/tutorial/add_arche_commod_recipe.rst index 093c928d..bfca70f9 100644 --- a/source/user/tutorial/add_arche_commod_recipe.rst +++ b/source/user/tutorial/add_arche_commod_recipe.rst @@ -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 -------------------------- diff --git a/source/user/tutorial/add_deploy.rst b/source/user/tutorial/add_deploy.rst index 1497fdfa..2400f985 100644 --- a/source/user/tutorial/add_deploy.rst +++ b/source/user/tutorial/add_deploy.rst @@ -75,8 +75,7 @@ where: Activity: Add a New Institution -------------------------------- -Using the table below and the DeployInst template above, fill out the commodities -template. +Using the table below and the template above, add the ``DeployInst`` block. +-----------------------------+-------------+-----------+ | Prototype | build_times | n_build | From 08fbcda3a4f0b1bd67fce85fac523b2b1a8880a6 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 15:44:48 -0800 Subject: [PATCH 19/21] remove commodity blocks from recap --- .../user/tutorial/cyclus_tutorial_recap.rst | 100 +----------------- 1 file changed, 1 insertion(+), 99 deletions(-) diff --git a/source/user/tutorial/cyclus_tutorial_recap.rst b/source/user/tutorial/cyclus_tutorial_recap.rst index a2f00b30..a2c19195 100644 --- a/source/user/tutorial/cyclus_tutorial_recap.rst +++ b/source/user/tutorial/cyclus_tutorial_recap.rst @@ -42,22 +42,6 @@ Basic Tutorial Input NullInst - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - UraniumMine @@ -241,23 +225,7 @@ Add a Second Reactor Input NullInst - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - - + UraniumMine @@ -470,39 +438,6 @@ Recycle Input - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - - - used_mox_fuel - 1.0 - - - fresh_mox - 1.0 - - - separated_fissile - 1.0 - - - separated_waste - 1.0 - - UraniumMine @@ -849,39 +784,6 @@ DeployInst Input - - u_ore - 1.0 - - - fresh_uox - 1.0 - - - tails - 1.0 - - - spent_uox - 1.0 - - - used_mox_fuel - 1.0 - - - fresh_mox - 1.0 - - - separated_fissile - 1.0 - - - separated_waste - 1.0 - - UraniumMine From 071aad186e1a3a91210519ef106d59098e73120e Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 5 Feb 2026 16:17:45 -0800 Subject: [PATCH 20/21] remove commodity from check section --- source/user/tutorial/add_commod_recipe.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/user/tutorial/add_commod_recipe.rst b/source/user/tutorial/add_commod_recipe.rst index 24e7a2f6..f4577b2d 100644 --- a/source/user/tutorial/add_commod_recipe.rst +++ b/source/user/tutorial/add_commod_recipe.rst @@ -146,7 +146,7 @@ names in cyclus and ``_`` should be used instead): The recipe name ``fresh_uox`` is specified, as are the isotope nuclide IDs and the corresponding mass fraction of each nuclide. The ``fresh_uox`` is composed of 4% U-235 and 96% U-238. -Check: Complete Commodity and Recipe blocks +Check: Complete Recipe block +++++++++++++++++++++++++++++++++++++++++++++++ The recipe section of you input file should now look like: From c9cf153d21e68e39736c0f9e2b28cd02126633de Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Fri, 6 Feb 2026 08:44:58 -0800 Subject: [PATCH 21/21] fix undestanding archetypes link --- source/user/tutorial/add_reg_inst.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index 3382bdf5..722091a8 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -28,7 +28,7 @@ you can run ``cyclus --a`` to check that the archetypes are installed. Since these are all archetypes, no matter what library they're from, we must include them into the the Archetypes block that we already have. -Using the template on the `Understanding Archetypes `_page, +Using the template on the `Understanding Archetypes `_ page, append two ``spec`` blocks into the Archetypes block for the variables listed in the table below. +-------------+-------------+------------------+