-
Notifications
You must be signed in to change notification settings - Fork 12
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.
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
Add information for closed fuel cycles #152
Changes from 91 commits
e48ecff
ac0d89f
34d7fd3
8a96336
98ea6c6
eebb014
ef781fd
566237e
27e2ad4
4871a57
3cfcce0
ae9c195
8b63874
df8a085
92b7333
1b8bd9d
11ceb03
59cf477
d3a0649
6c101b3
b648e33
e756cad
dcad34e
80933ef
bc964b7
794ad41
cef3e8a
b9e274e
7cb2937
fef89e3
4a27f5f
978b95d
0f38693
d4a2145
da694ea
e9b769a
c4f775a
da03bd5
0d1268f
0335ffc
d91c563
296719a
b5c4533
88ad140
82210ff
362fdce
122e3e8
a7c0c74
d993063
c029daf
1c754e8
c3780ed
5677977
e1b53eb
17b354b
3d99e30
206c929
e2dfce1
9f33fd9
fd1feab
4479fb9
7d320f2
75f3891
2aff803
c230f34
2f24885
6dbefd2
d361aec
eecee5b
80b3939
2eebec2
135df87
5faf389
908be90
1585a3d
db37b0c
895abf0
7471eaa
443dec7
39f4dac
9943e4d
75860ce
c6accae
34661cf
b19b445
92533d6
b58da04
2845cff
eb4ab00
5be31bf
eeb1473
3cad083
d9018ae
e355a38
aa60311
65e598c
366ef68
f3653ed
8aa9809
f5ff264
2f36e4b
720ca2a
c6cb8e4
c26be23
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As a comment, final analyses should be in their own folder. It should not be a subfolder of "input." Finding and referencing these notebooks is not intuitive. My imagined internal dialogue of a future reviewer: "Ah where are her results?" "The... input folder? Seems a bit recursive, no?" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This repository contains files related to modeling a variety of transition scenarios. The top-most There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ok I just looked through the I like the README in the haleu directory and I think it helps describe what is in the haleu directory. Alongside haleu, there are other transition scenarios in the Amanda, I see that you clearly describe the input files and the analysis files. The analysis notebooks are contained in the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This issue could resolve itself if the top-level inputs folder was renamed to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I added the people from this conversation to the PR, but, for posterity's sake, refer to #153 (which tries to rectify these comments). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I place the output databases in inputs/haleu/outputs. That directory isn't in this repo because those files get generated by running the inputs. The run_multiple_inputs and the analysis notebooks also assume this, hit it can easily be updated as desired. I can add this information into the readme for the haleu directory though. |
Large diffs are not rendered by default.
Large diffs are not rendered by default.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a good idea to come up with a naming convention, but I recommend making the names more informative than "scenarioX.xml". I will have to reference the table below in order to figure out which table is which. ALSO, what if you change the files and the results change? You'll have to update everything somehow which challenges reproducibility and code maintenance.
Just as a quick suggestion, what about something like:
FC{OT or C}_AR0{0,1,2,3}_GPCT{0, 1, NA}_SC{#}_V{00X}.xml
(fuel cycle) (advanced reactors) (growth percent) (scenario number) (version)
For scenario 2 this would look like
FCC_AR01_GPCT00_SC02_V001.xml
It might be a bit more cumbersome, but once users become familiar with this naming convention, it will help them (and also possibly you) figure out what each input file is supposed to run. The table in this file is good and useful, but you need a stronger naming convention for your files. Also include a description of your naming convention -- and stick to it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feels less intuitive to me, and your example for how it works is wrong, as Scenario 2 is a once-through fuel cycle. I feel like your convention would still require referencing back to a table of which advanced reactor number corresponds with which advanced reactor. I'm also not sure why you would include a version number in the file name if it's all version controlled.
I had previously used a convention of
reactor1_..._reactor_N_growth.xml
, which worked well for just the once-through scenarios. Adding in the closed fuel cycles, I felt that the file names would get too cumbersome and inconsistent (especially given that Scenarios 14 and 15 only differ by the material being reprocessed) and I felt like using the scenario numbers would be the easiest and cleanest. I understand that this may require users to reference the table in the README, but that's why I made sure to include the table as the input file names aren't descriptive without it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for the error in my example. The purpose of having a version number is in case you had multiple updated files. I don't think there's a "release" associated with this repository. It can be hard to reference a specific file version without a release tag.
Sure, it's cumbersome, but could be useful if there were many more input files than currently exist. You don't have to use it. However, I don't think users should be required to reference a readme in order to understand approximately what the file contains.