Tutorial Updates by abachma2 · Pull Request #433 · cyclus/cyclus.github.com

abachma2 · 2025-10-28T20:40:15Z

Summary of Changes

This PR addresses some of the items identified by me in #427 to update the user tutorial. The changes are generally pretty minor: fixing typos, correcting formats, making things consistent across the tutorial. Some of the wording changes improve the clarity of the tutorial for me and I welcome discussion if you think the changes make things less clear.

Design Notes

Check the box if your change does not break any of the following:

API for Cyclus modules
Input files
Output tables for post processing tools

Related CEPs and Issues

This PR addresses some of the items in #427, but not all of them so the issue should remain open after merging.

Associated Developers

Testing and Validation

I have read the Contributing to Cyclus guide
I have compiled and run the code locally
I have added or updated relevant tests
I have added documentation for new or changed features
This code follows the style guide
I have updated the changelog

Reviewers, please refer to the Cyclus Guide for Reviewers.

gonuke · 2025-10-29T18:50:55Z

See also #426

abachma2 · 2025-10-29T21:43:31Z

See also #426

I will add that to the Tutorial update project. I don't want to do that update with this PR to maintain some formal scope. I can get another PR in to address that issue.

gonuke

Thanks for this careful review @abachma2 . I have reviewed all your changes, but haven't done a full read to confirm that the changes are any more/less consistent with the tutorial - I'll trust you on that. There are a few places where I did look at the context of the changes and asked some questions.

gonuke · 2025-11-14T17:44:23Z

source/user/tutorial/add_arche.rst

    </archetypes>

-Once complete, append the archetypes section under the control section of input file [#f1]_.
+The order of the archetypes in this block is of minor consequence. Once complete, append the archetypes section under the control section of input file [#f1]_.


I'm not sure I know what "minor consequence" means.... does the order matter at all?

As far as I know, the only ordering that matters in a Cyclus input file is that the control block needs to go first. I don't know if there are any other things that matter. I can change minor to no if that is more accurate.

I think "no consequence" would be better

Forgot to save that with my last round of edits. It is now changed.

source/user/tutorial/sim_parm.rst

source/user/tutorial/add_commod_recipe.rst

source/user/tutorial/add_proto.rst

source/user/tutorial/add_reg_inst.rst

gonuke · 2025-11-14T18:09:11Z

source/user/tutorial/add_reg_inst.rst

+There can be multiple ``entry`` blocks within the same institution, hence the 
+``...`` in the block. Multiple entry blocks means that multiple prototypes 
+are deployed at the start of the simulation. 


We don't have ... in this example. I think we need to add that for this to make sense

I did add that in. Line 193.

source/user/tutorial/add_reg_inst.rst

gonuke · 2025-11-14T18:14:46Z

source/user/tutorial/add_sep.rst

                 <item>
-                   <comp>_______</comp>
-                   <eff>_______</eff>
+                   <comp>[nuclide]</comp>


I think this needs to refer to an element??? or is that just a convention. Separations acts on elements not isotopes...

Elsewhere on the website I see that we have nuclide: https://fuelcycle.org/user/cycamoreagents.html#cycamore-separations. I don't actually know that answer.

On a community call, I believe we came to a consensus that this input can be a nuclide because an input of 94000 works in an input file.

dean-krueger · 2025-11-22T13:59:27Z

source/user/tutorial/add_reg_inst.rst

+* ``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.
+


Perhaps a note that RegionArchetype isn't (currently, at least) a valid input in this block and that it must be replaced with the actual region name with an example like <NullRegion>. What you have implies this, but users new to Cyclus/XML may get tripped up by this.

dean-krueger · 2025-11-22T14:06:52Z

source/user/tutorial/add_second_reactor.rst

  </facility>

-Append this prototype right after the ``1178MWe BRAIDWOOD_1`` prototype.
+Append this prototype right after the ``1178MWe BRAIDWOOD_1`` prototype in your input file.


I think in the last tutorial you changed 1178MWe BRAIDWOOD_1 to 1178MWe ReactorPlant Unit 1

Yes. I changed it in the one file as a suggestion. If folks think it's a good change, then I'll propagate it throughout the rest of the tutorial.

dean-krueger · 2025-11-22T14:07:25Z

source/user/tutorial/add_second_reactor.rst

  </entry>

-below the ``1178MWe BRAIDWOOD_1`` entry block. The Reactor section
+below the ``1178MWe BRAIDWOOD_1`` entry block. The second institution section


See above about 1178MWe ReactorPlant Unit 1 vs BRAIDWOOD

See comment above.

dean-krueger

Awesome work, this is a lot better for having been gone through like you did. I left two or three comments separately, but they're all pretty minor. Otherwise looks good to me!

abachma2

Thanks for the reviews @gonuke and @dean-krueger. If you like some of the changes I've made, let me know and I can propagate them through. There are still 1-2 discussion points left.

abachma2 · 2025-11-24T16:23:07Z

source/user/tutorial/add_proto.rst

 .. code-block:: XML

-        <outrecipe>[outrecipe]</outrecipe>
+        <outrecipe>[string]</outrecipe>


I can make that update.

abachma2 · 2025-11-24T16:25:05Z

source/user/tutorial/add_proto.rst

    <config>
-      <Archetype>
-        <outcommod>outcommod</outcommod>
+      <Source>


Which one do you think is better for the tutorial? I think putting the archetype name in the <Archetype> area for the template is better, because it's easier to distinguish what are the archetype-specific inputs vs what are the facility inputs (e.g., lifetime, config).

abachma2 · 2025-11-24T16:27:28Z

source/user/tutorial/add_reg_inst.rst

+* ``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.
+


abachma2 · 2025-11-24T16:28:24Z

source/user/tutorial/add_second_reactor.rst

  </facility>

-Append this prototype right after the ``1178MWe BRAIDWOOD_1`` prototype.
+Append this prototype right after the ``1178MWe BRAIDWOOD_1`` prototype in your input file.


Yes. I changed it in the one file as a suggestion. If folks think it's a good change, then I'll propagate it throughout the rest of the tutorial.

abachma2 · 2025-11-24T16:28:33Z

source/user/tutorial/add_second_reactor.rst

  </entry>

-below the ``1178MWe BRAIDWOOD_1`` entry block. The Reactor section
+below the ``1178MWe BRAIDWOOD_1`` entry block. The second institution section


See comment above.

dean-krueger · 2025-11-25T18:06:46Z

If you like some of the changes I've made, let me know

I do!

ConnorWelch-OSU · 2026-01-07T22:53:56Z

source/user/tutorial/add_proto.rst

@@ -488,8 +490,8 @@ The sink facility archetype is:
    <config>
      <Archetype>


The <Archetype> tag in this template is closed with </Sink>.

abachma2

Thanks for the comments, everyone. I have finished propagating some of the suggested changes through the rest of the tutorial. If there is nothing else that needs to be done to address the matters in #427, this should be ready to merge.

I have also fixed some minor formatting things within the most recent changes.

ConnorWelch-OSU

All of these changes look good to me. I did however notice a typo with the naming of the second reactor, and I called it out in comment on each file that it appears in. I believe I found all of them, but I may have missed some.

source/user/tutorial/add_deploy.rst

source/user/tutorial/add_second_reactor.rst

source/user/tutorial/cyclus_tutorial_recap.rst

source/user/tutorial/input_deployinst.xml

source/user/tutorial/input_recycle.xml

source/user/tutorial/input_secondreactor.xml

abachma2 · 2026-01-09T18:21:59Z

Thanks for catching all of that @ConnorWelch-OSU. I think we should be good to merge this and start working on some of the other items in #427 and other issues.

ConnorWelch-OSU · 2026-01-09T20:30:20Z

Thanks for catching all of that @ConnorWelch-OSU. I think we should be good to merge this and start working on some of the other items in #427 and other issues.

I should have pointed it out explicitly because its kind of a sneaky typo, but the other issue with the second reactor naming is that a lot of them are 1000 Watt electric instead of 1000 Megawatt electric. Sorry about that.

ConnorWelch-OSU

Everything looks good to me. This should be ready to merge.

gonuke

I think this is ready to merge... there may be additional things we want to change, but I think this large PR has tackled most of it and additional things will emerge better after this has been merged.

dean-krueger · 2026-01-13T19:27:05Z

I believe my concerns were addressed. I'm happy for this to be merged as well!

dean-krueger

LGTM!

abachma2 added 18 commits October 27, 2025 16:18

remove mention of internet connection

7a3844e

consolidate Cyclus and Cycamore to single link

19ad825

make edits suggested in cyclus#427

e01ca79

make minor revisions, per cyclus#427

ce47b36

minor revisions, per cyclus#427

5eac5ec

make formatting more consistent

5f3289c

changes, per cyclus#427, includes some reordering

0481e5f

remove cloud paragraph, add terminal running

b0e0aaf

add note about insts deploying prototypes

7d653d9

changes per cyclus#427

7e891e5

consistent formatting in archetype names

70ce69e

improve consistency in inputs/formatting

208ac71

make formattting consistent, per cyclus#427

0342e4d

fix typo

7afe45d

changes per cyclus#427, make things consistent

ea3f803

remove mention of region

9fb480c

correct institution name

4650bce

adjust text for second problem

abff198

abachma2 requested review from GersonEsquivel, RhysMacMillan, SamarAbdelkawy, dean-krueger, gonuke and katyhuff October 28, 2025 20:40

abachma2 self-assigned this Oct 28, 2025

abachma2 added this to 2025 Tutorial Update Oct 28, 2025

gonuke requested changes Nov 14, 2025

View reviewed changes

remove mention of institutions and regions

e560a4e

dean-krueger reviewed Nov 22, 2025

View reviewed changes

dean-krueger requested changes Nov 22, 2025

View reviewed changes

abachma2 commented Nov 24, 2025

View reviewed changes

abachma2 added 3 commits November 24, 2025 11:38

Merge branch 'source' into tutorial

0906128

clarify RegionArchetype, per @dean-krueger comment

42723b0

add section about common inputs, note about recipe names

b94a433

ConnorWelch-OSU reviewed Jan 7, 2026

View reviewed changes

abachma2 added 4 commits January 8, 2026 13:26

change <Archetype> to archetype name

7284d05

change BRAIDWOOD and Exelon names

ea0cd53

finish archetype descriptions

1e6fbe0

fix DRE text formatting

4840280

abachma2 commented Jan 8, 2026

View reviewed changes

abachma2 requested review from ConnorWelch-OSU, dean-krueger and gonuke January 8, 2026 21:35

ConnorWelch-OSU suggested changes Jan 9, 2026

View reviewed changes

make Lightwater_1 prototype name consistent

d4fe19e

abachma2 requested a review from ConnorWelch-OSU January 9, 2026 18:22

fix 1000We to 1000MWe for one of the prototypes

b8b451e

ConnorWelch-OSU approved these changes Jan 9, 2026

View reviewed changes

gonuke approved these changes Jan 13, 2026

View reviewed changes

dean-krueger approved these changes Jan 13, 2026

View reviewed changes

dean-krueger merged commit 03a9fd7 into cyclus:source Jan 13, 2026
2 checks passed

github-project-automation bot moved this to Done in 2025 Tutorial Update Jan 13, 2026

		* ``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.

		@@ -488,8 +490,8 @@ The sink facility archetype is:
		<config>
		<Archetype>

Conversation

abachma2 commented Oct 28, 2025

Summary of Changes

Design Notes

Related CEPs and Issues

Associated Developers

Testing and Validation

Uh oh!

gonuke commented Oct 29, 2025

Uh oh!

abachma2 commented Oct 29, 2025

Uh oh!

gonuke left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dean-krueger Nov 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dean-krueger left a comment

Choose a reason for hiding this comment

Uh oh!

abachma2 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dean-krueger commented Nov 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abachma2 left a comment

Choose a reason for hiding this comment

Uh oh!

ConnorWelch-OSU left a comment

Choose a reason for hiding this comment

Uh oh!

dean-krueger Nov 22, 2025 •

edited

Loading