From 8b8aa14ced073cec4a6dcb369fb2ce91115b18b9 Mon Sep 17 00:00:00 2001 From: abachma2 Date: Mon, 28 Feb 2022 13:47:58 -0600 Subject: [PATCH 01/10] formatting for file, add link to CONTRIBUTING.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6347eec0eb..83ef63fff4 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ make -j8 ``` You may also compile a debug version of Moltres by replacing the last line in -build_libmesh_and_moltres.sh with `METHOD=dbg make +`build_libmesh_and_moltres.sh` with `METHOD=dbg make -j8`. Note that you should replace `8` with the number of processors available on your machine. @@ -59,6 +59,8 @@ requests should be submitted to the `devel` branch of the `arfc/moltres` repository. Each pull request is automatically tested for style and for whether it breaks any of the core Moltres physics capabilities. +A full list of contributing guildeines can be found [here](https://github.com/arfc/blob/devl/CONTRIBUTING.md) + ## Contact Please post to our discussion list at From f4f801b6ddac0dce3f604337b0ea9fd0ab1b67e8 Mon Sep 17 00:00:00 2001 From: abachma2 Date: Mon, 28 Feb 2022 14:13:01 -0600 Subject: [PATCH 02/10] correct formatting for BEAVRS --- tutorial/PinCell/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorial/PinCell/README.md b/tutorial/PinCell/README.md index 179687a254..b3892b5266 100644 --- a/tutorial/PinCell/README.md +++ b/tutorial/PinCell/README.md @@ -6,8 +6,8 @@ These will be used to generate an JSON file, which can be used by Moltres. ### SCALE Input file -Here, the scale input file for a pin cell based on the [BEAVRS benchmark] -(https://crpg.mit.edu/research/beavrs) can be found. +Here, the scale input file for a pin cell based on the +[BEAVRS benchmark](https://crpg.mit.edu/research/beavrs) can be found. For group constant generation, the standard 2 group LWR structure is used. The `pin\_cell.scale` file contains branches and burnup that will generate group constants at different temperatures and burnup levels. From da015ecba527ccfef015266f7e20f81057388f0b Mon Sep 17 00:00:00 2001 From: abachma2 Date: Mon, 28 Feb 2022 14:15:27 -0600 Subject: [PATCH 03/10] fied awkward sentence --- tutorial/PinCell/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tutorial/PinCell/README.md b/tutorial/PinCell/README.md index b3892b5266..a6860fbf5a 100644 --- a/tutorial/PinCell/README.md +++ b/tutorial/PinCell/README.md @@ -6,8 +6,8 @@ These will be used to generate an JSON file, which can be used by Moltres. ### SCALE Input file -Here, the scale input file for a pin cell based on the -[BEAVRS benchmark](https://crpg.mit.edu/research/beavrs) can be found. +The SCALE input file for a pin cell based on the +[BEAVRS benchmark](https://crpg.mit.edu/research/beavrs) is found here. For group constant generation, the standard 2 group LWR structure is used. The `pin\_cell.scale` file contains branches and burnup that will generate group constants at different temperatures and burnup levels. From dc661f639fcacdb032c3cdebfcc4e0ee5cefe4db Mon Sep 17 00:00:00 2001 From: abachma2 Date: Mon, 28 Feb 2022 14:23:39 -0600 Subject: [PATCH 04/10] add link to serpent user forum --- tutorial/step01_groupConstants/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tutorial/step01_groupConstants/README.md b/tutorial/step01_groupConstants/README.md index a462a6334f..378d7b8a8c 100644 --- a/tutorial/step01_groupConstants/README.md +++ b/tutorial/step01_groupConstants/README.md @@ -8,8 +8,8 @@ Because there is no desire to homogenize spatially here, the materials that the own infinite universe. Then, this universe should have its group constants generated using the "set gcu ". It's important that universe 0, the main universe, is not included. Serpent takes tallies for group constants in the first universe -it identifies, so including 0 means that no further universes will be included in GC generation. (please double check this on the serpent -forum). +it identifies, so including 0 means that no further universes will be included in GC generation. (please double check this on the +[serpent forum](ttuki.vtt.fi/serpent)). ### Serpent Input @@ -38,4 +38,4 @@ The syntax requires the arbitrary directory name you'd like to create, then the look at, then a file that maps primary branch names to temperatures, then a file that lists the secondary branch names, and lastly a file that maps universe numbers from serpent to material names. Group constants will be extracted for all materials listed in the last file. -The secBranch.txt file should be blank if no secondary branches were used, i.e. there is only one branch variation per burnup step. \ No newline at end of file +The secBranch.txt file should be blank if no secondary branches were used, i.e. there is only one branch variation per burnup step. From a9baf5c49829ae616d7447ee2b8904a2de2bad97 Mon Sep 17 00:00:00 2001 From: abachma2 Date: Mon, 28 Feb 2022 14:27:00 -0600 Subject: [PATCH 05/10] fix link and file formatting --- tutorial/step01_groupConstants/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/tutorial/step01_groupConstants/README.md b/tutorial/step01_groupConstants/README.md index 378d7b8a8c..643598b58d 100644 --- a/tutorial/step01_groupConstants/README.md +++ b/tutorial/step01_groupConstants/README.md @@ -14,15 +14,17 @@ it identifies, so including 0 means that no further universes will be included i ### Serpent Input Here, serpent input can be found to simulate ORNL's molten salt reactor experiment, documented largely on websites like -(this)[http://www.energyfromthorium.com/pdf/] one. +[this](http://www.energyfromthorium.com/pdf/) one. For group constant generation, Cole Gentry found that a 4 group structure with three thermal groups and one fast group works well in the graphite moderated FHR. There is also an available recommended 13 group structure, which could be found by changing -some comment characters around in the include file defining group structures. The PDF of these findings can be found (here)[http://trace.tennessee.edu/utk_graddiss/3695/]. +some comment characters around in the include file defining group structures. +The PDF of these findings can be found +[here](http://trace.tennessee.edu/utk_graddiss/3695/). The "fuel" file contains "cards" (a relic term referring to the fortran-dominated reactor physics ages of yore) that will generate group constants at a few temperatures, and likewise for the "moder" file. -Like a cooking show, the important results have already been prepared for you in the "fuel.coe" and "moder.coe" files, which +Like a cooking show, the important results have already been prepared for you in the ```fuel.coe``` and ```moder.coe``` files, which get parsed by ```serpentTools``` in the extractSerpent2GCs script. ```serpentTools``` is a suite of parsers designed by GATech for parsing ```SERPENT``` output files. More information can be found at http://serpent-tools.readthedocs.io/en/latest/ ### Command to run: @@ -38,4 +40,4 @@ The syntax requires the arbitrary directory name you'd like to create, then the look at, then a file that maps primary branch names to temperatures, then a file that lists the secondary branch names, and lastly a file that maps universe numbers from serpent to material names. Group constants will be extracted for all materials listed in the last file. -The secBranch.txt file should be blank if no secondary branches were used, i.e. there is only one branch variation per burnup step. +The ```secBranch.txt``` file should be blank if no secondary branches were used, i.e. there is only one branch variation per burnup step. From 2c5a5019b29f6b7fdc70430226c724e98f48efd3 Mon Sep 17 00:00:00 2001 From: abachma2 Date: Mon, 28 Feb 2022 14:28:36 -0600 Subject: [PATCH 06/10] fix file format --- tutorial/step01_groupConstants/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorial/step01_groupConstants/README.md b/tutorial/step01_groupConstants/README.md index 643598b58d..b13b2139ff 100644 --- a/tutorial/step01_groupConstants/README.md +++ b/tutorial/step01_groupConstants/README.md @@ -25,7 +25,7 @@ The PDF of these findings can be found The "fuel" file contains "cards" (a relic term referring to the fortran-dominated reactor physics ages of yore) that will generate group constants at a few temperatures, and likewise for the "moder" file. Like a cooking show, the important results have already been prepared for you in the ```fuel.coe``` and ```moder.coe``` files, which -get parsed by ```serpentTools``` in the extractSerpent2GCs script. ```serpentTools``` is a suite of parsers designed by GATech for parsing ```SERPENT``` output files. More information can be found at http://serpent-tools.readthedocs.io/en/latest/ +get parsed by ```serpentTools``` in the ```extractSerpent2GCs``` script. ```serpentTools``` is a suite of parsers designed by GATech for parsing ```SERPENT``` output files. More information can be found at http://serpent-tools.readthedocs.io/en/latest/ ### Command to run: From 0ca5f6659436febabe5e282815d368ec10f78488 Mon Sep 17 00:00:00 2001 From: abachma2 Date: Mon, 28 Feb 2022 14:29:55 -0600 Subject: [PATCH 07/10] fix serpent forum link --- tutorial/step01_groupConstants/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorial/step01_groupConstants/README.md b/tutorial/step01_groupConstants/README.md index b13b2139ff..14a168412d 100644 --- a/tutorial/step01_groupConstants/README.md +++ b/tutorial/step01_groupConstants/README.md @@ -9,7 +9,7 @@ own infinite universe. Then, this universe should have its group constants gener It's important that universe 0, the main universe, is not included. Serpent takes tallies for group constants in the first universe it identifies, so including 0 means that no further universes will be included in GC generation. (please double check this on the -[serpent forum](ttuki.vtt.fi/serpent)). +[serpent forum](https://www.ttuki.vtt.fi/serpent)). ### Serpent Input From 89a7aae1a07a263a7bf3a9fc506955a05f38d614 Mon Sep 17 00:00:00 2001 From: abachma2 Date: Mon, 28 Feb 2022 14:30:37 -0600 Subject: [PATCH 08/10] fix serpent forum link --- tutorial/step01_groupConstants/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorial/step01_groupConstants/README.md b/tutorial/step01_groupConstants/README.md index 14a168412d..67d4feb914 100644 --- a/tutorial/step01_groupConstants/README.md +++ b/tutorial/step01_groupConstants/README.md @@ -9,7 +9,7 @@ own infinite universe. Then, this universe should have its group constants gener It's important that universe 0, the main universe, is not included. Serpent takes tallies for group constants in the first universe it identifies, so including 0 means that no further universes will be included in GC generation. (please double check this on the -[serpent forum](https://www.ttuki.vtt.fi/serpent)). +[serpent forum](https://ttuki.vtt.fi/serpent)). ### Serpent Input From d7cbd7b49989cab8f62cc98a0fad2e23e2ce983a Mon Sep 17 00:00:00 2001 From: abachma2 Date: Tue, 1 Mar 2022 12:31:33 -0600 Subject: [PATCH 09/10] address comments from @smpark7 --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83ef63fff4..fa075ca185 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ make -j8 ``` You may also compile a debug version of Moltres by replacing the last line in -`build_libmesh_and_moltres.sh` with `METHOD=dbg make +the code block above with `METHOD=dbg make -j8`. Note that you should replace `8` with the number of processors available on your machine. @@ -59,7 +59,8 @@ requests should be submitted to the `devel` branch of the `arfc/moltres` repository. Each pull request is automatically tested for style and for whether it breaks any of the core Moltres physics capabilities. -A full list of contributing guildeines can be found [here](https://github.com/arfc/blob/devl/CONTRIBUTING.md) +A full list of contributing guidelines can be found +[here](https://github.com/arfc/moltres/blob/devel/CONTRIBUTING.md) ## Contact From b3f8f0553ae923498d7e7c0583dc9cba2e18ceee Mon Sep 17 00:00:00 2001 From: abachma2 Date: Tue, 1 Mar 2022 13:18:33 -0600 Subject: [PATCH 10/10] address change requested by @smpark7 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fa075ca185..1814eb99d9 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ repository. Each pull request is automatically tested for style and for whether it breaks any of the core Moltres physics capabilities. A full list of contributing guidelines can be found -[here](https://github.com/arfc/moltres/blob/devel/CONTRIBUTING.md) +[here](https://github.com/arfc/moltres/blob/devel/CONTRIBUTING.md). ## Contact