svalinn / r2s-act

Rigorous 2 Step Activation Workflow
4 stars 7 forks source link

Adding metadata to 'gammas' (and other files) #24

Open erelson opened 11 years ago

erelson commented 11 years ago

I have added support* for comment lines (using #) at the top of the 'gammas' file, but have not implemented automatically creating this comment yet. The basis for doing this is to supply a bit of extra information for when someone looks at the gammas file at some later date (Andy's idea, back in September, I think). The contents I have in mind for this comment/header line are:

The problem title would be analogous to MCNP's title card, and would be specified as a new parameter in the r2s.cfg file.

Is the problem title unnecessary? Do we want this concept added to other files in the workflow? (e.g. alara_input, phtn_src)

*support, as in, source.F90 simply skips over these lines

elliottbiondo commented 11 years ago

That all sounds very good. I do think the problem title would be a useful addition. For example, in my Shine work l do a single neutron calculation, but then I break up the problem to different source regions for separate photon transport calcs. Each one of these regions has its own r2s.cfg, so being able to give each a title would be nice. In any case, you can just supply a generic default value like "r2s-act problem" and it won't be any burden to the user.

erelson commented 11 years ago

This is currently implemented so that the r2s_step2.py script passes the isotope and cooling step to write_gammas.py. Passing a title will work as well - just another keyword parameter in the function call. source_gammas.F90 handles comment lines, as already mentioned.

Still need to note this feature in documentation, and add tests for the updated code.