From d3e10a61fb579aafaf86576c8019692ec540e38c Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 22 Jan 2026 15:45:31 -0800 Subject: [PATCH 1/4] updated input file names --- source/user/tutorial/add_deploy.rst | 3 +-- source/user/tutorial/add_reg_inst.rst | 2 +- source/user/tutorial/add_second_reactor.rst | 2 +- source/user/tutorial/mod_rxtr.rst | 2 +- 4 files changed, 4 insertions(+), 5 deletions(-) diff --git a/source/user/tutorial/add_deploy.rst b/source/user/tutorial/add_deploy.rst index 71bc6672..71c9de57 100644 --- a/source/user/tutorial/add_deploy.rst +++ b/source/user/tutorial/add_deploy.rst @@ -131,7 +131,6 @@ institution blocks. ``ExampleInstitution`` is a placeholder for your institution name, and in this scenario only one of each prototype will be deployed since ``n_build`` has a value of 1 for each. -This example is now complete. Save your file as the desired file name (with ``.xml`` -extension) and run your code through |Cyclus|. If your simulation runs into errors, +This example is now complete. Save your file as 'tutorial_deployinst.xml' and run your code through |Cyclus|. If your simulation runs into errors, sample files can be found `here `_ under ``input_deployinst.xml`` or ``output_deployinst.sqlite``. diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index ee6d6d6e..6bf5adc7 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -472,7 +472,7 @@ Activity: Save your Input File You are now ready to generate a full |Cyclus| input file. -1. Save your input file as 'cyclus_intro_file.xml' +1. Save your input file as 'tutorial_oncethrough.xml' Check: Full Input File diff --git a/source/user/tutorial/add_second_reactor.rst b/source/user/tutorial/add_second_reactor.rst index b71def9b..3c97816b 100644 --- a/source/user/tutorial/add_second_reactor.rst +++ b/source/user/tutorial/add_second_reactor.rst @@ -119,7 +119,7 @@ of the region block should now look like, Note: the blank space between ```` and ```` is for additional institutions in the future. -Save your input file as input_file2.xml and run the |Cyclus| simulation. +Save your input file as 'tutorial_secondreactor.xml' and run the |Cyclus| simulation. If your simulation runs into errors, sample files can be found `here `_ under ``input_secondreactor.xml`` or ``ouput_secondreactor.sqlite``. diff --git a/source/user/tutorial/mod_rxtr.rst b/source/user/tutorial/mod_rxtr.rst index 49498d26..a924084f 100644 --- a/source/user/tutorial/mod_rxtr.rst +++ b/source/user/tutorial/mod_rxtr.rst @@ -33,7 +33,7 @@ Add an accepted commodity for the repository to be Separated-Waste. Activity: Save your Input File -------------------- -The input for this example is now complete. Save your input file as 'recycle_input.xml'. If +The input for this example is now complete. Save your input file as 'tutorial_recycle.xml'. If your simulation runs into errors, sample files can be found `here `_ under ``input_recycle.xml`` or ``ouput_recycle.sqlite``. From 0ac96c736d6df7027ba542cb473328965c03cf63 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 22 Jan 2026 15:59:43 -0800 Subject: [PATCH 2/4] update missed input file name --- 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 6bf5adc7..becc0b2e 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -353,7 +353,7 @@ Check: Complete Region block Activity: Save your input file ------------------------------ -Save your input file as ``cyclus_intro_file.xml`` +Save your input file as ``tutorial_oncethrough.xml`` Activity: Add an extra institution into the Region From 4d0d8470166ef1242eeb2635207b46725feea436 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Thu, 22 Jan 2026 16:03:29 -0800 Subject: [PATCH 3/4] change input file names to inline code --- source/user/tutorial/add_deploy.rst | 2 +- source/user/tutorial/add_reg_inst.rst | 2 +- source/user/tutorial/add_second_reactor.rst | 2 +- source/user/tutorial/mod_rxtr.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/user/tutorial/add_deploy.rst b/source/user/tutorial/add_deploy.rst index 71c9de57..9fa5712d 100644 --- a/source/user/tutorial/add_deploy.rst +++ b/source/user/tutorial/add_deploy.rst @@ -131,6 +131,6 @@ institution blocks. ``ExampleInstitution`` is a placeholder for your institution name, and in this scenario only one of each prototype will be deployed since ``n_build`` has a value of 1 for each. -This example is now complete. Save your file as 'tutorial_deployinst.xml' and run your code through |Cyclus|. If your simulation runs into errors, +This example is now complete. Save your file as ``tutorial_deployinst.xml`` and run your code through |Cyclus|. If your simulation runs into errors, sample files can be found `here `_ under ``input_deployinst.xml`` or ``output_deployinst.sqlite``. diff --git a/source/user/tutorial/add_reg_inst.rst b/source/user/tutorial/add_reg_inst.rst index becc0b2e..028f1224 100644 --- a/source/user/tutorial/add_reg_inst.rst +++ b/source/user/tutorial/add_reg_inst.rst @@ -472,7 +472,7 @@ Activity: Save your Input File You are now ready to generate a full |Cyclus| input file. -1. Save your input file as 'tutorial_oncethrough.xml' +1. Save your input file as ``tutorial_oncethrough.xml`` Check: Full Input File diff --git a/source/user/tutorial/add_second_reactor.rst b/source/user/tutorial/add_second_reactor.rst index 3c97816b..10542620 100644 --- a/source/user/tutorial/add_second_reactor.rst +++ b/source/user/tutorial/add_second_reactor.rst @@ -119,7 +119,7 @@ of the region block should now look like, Note: the blank space between ```` and ```` is for additional institutions in the future. -Save your input file as 'tutorial_secondreactor.xml' and run the |Cyclus| simulation. +Save your input file as ``tutorial_secondreactor.xml`` and run the |Cyclus| simulation. If your simulation runs into errors, sample files can be found `here `_ under ``input_secondreactor.xml`` or ``ouput_secondreactor.sqlite``. diff --git a/source/user/tutorial/mod_rxtr.rst b/source/user/tutorial/mod_rxtr.rst index a924084f..5dc7f10f 100644 --- a/source/user/tutorial/mod_rxtr.rst +++ b/source/user/tutorial/mod_rxtr.rst @@ -33,7 +33,7 @@ Add an accepted commodity for the repository to be Separated-Waste. Activity: Save your Input File -------------------- -The input for this example is now complete. Save your input file as 'tutorial_recycle.xml'. If +The input for this example is now complete. Save your input file as ``tutorial_recycle.xml``. If your simulation runs into errors, sample files can be found `here `_ under ``input_recycle.xml`` or ``ouput_recycle.sqlite``. From bbb56681dad28af7c65ea696f763f2b78899cde1 Mon Sep 17 00:00:00 2001 From: ConnorWelch-OSU Date: Fri, 23 Jan 2026 09:46:01 -0800 Subject: [PATCH 4/4] update file names for running in jupyter --- source/user/tutorial/run_cyclus_native.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/user/tutorial/run_cyclus_native.rst b/source/user/tutorial/run_cyclus_native.rst index 03d752d6..4f579c13 100644 --- a/source/user/tutorial/run_cyclus_native.rst +++ b/source/user/tutorial/run_cyclus_native.rst @@ -55,13 +55,13 @@ Jupyter Notebook Scenario Execution -------------------------------------------- 1. Go to the Jupyter notebook, making sure you are in the same folder as the input file 2. Remove any old |Cyclus| output files by: ``!rm tutorial.sqlite`` -3. Run |Cyclus| by: ``!cyclus input.xml -o tutorial_singlerx.sqlite`` +3. Run |Cyclus| by: ``!cyclus tutorial_oncethrough.xml -o tutorial_output_oncethrough.sqlite`` .. image:: cyclus_in_IP.png :align: center :alt: Running |Cyclus| in an IPython Notebook -When your simulation has finished, a file of the name ``tutorial_singlerx.sqlite`` +When your simulation has finished, a file of the name ``tutorial_output_oncethrough.sqlite`` will be in your file folder. Your Jupyter Notebook can then be used with `Cymetric `_ to analyze your data. Examples of how to use Cymetric can be found in the `GitHub