JeffersonLab / gluex_MCwrapper

1 stars 4 forks source link

SubmitSim needs info on how to supply command line arguments for the generators #46

Closed nsjarvis closed 3 years ago

nsjarvis commented 4 years ago

I was at a loss to figure out how to specify -f for gen_amp. The secret solution was to add a line to the top of the configuration file containing the command line arguments. The next secret solution that I found was that gen_amp's -t parameter expects a positive value (even though the t-slope is negative).

Please could you add a help button to share these and any other secret tips and tricks with the unenlightened?

If you're aware of any undocumented generator features or common generator user mistakes, it would be helpful to start a collection of these on a help page to avoid wasting human and compute node time, even though it might seem like it should be beyond the scope of MCW. It would be really helpful. Passing the cmd line args as the first line in the config file is definitely a MCW feature.

T-Britton commented 4 years ago

I hesitate to call it a secret. It is clearly (imo) documented at the top of the example config files

#

The above line is used to provide additional options to the generator within the wrapper. These options do NOT include output file names, run numbers, and number of events which are controlled by the wrapper

because it is a wrapper of the generators I don't believe it to be MCWrapper's duty to provide the manuals of all of the generators. I agree it would be nice and should be done, and should a page exist I am happy to link to it....however this is not an MCwrapper issue. This should be brought up with the GlueX Software group next monday.

nsjarvis commented 4 years ago

I was using a variant of $HALLD_SIM_HOME/src/programs/Simulation/gen_amp/gen_2k.cfg which does not have the information in it about the command line parameters. I don't even know where the example generators are, sorry.

Please could you add a help popup to tell other people that the cmd line args can be passed to the generator in this way?

I will mention the generator documentation in the software meeting (Tues 3pm).

T-Britton commented 4 years ago

For the record: $MCWRAPPER_CENTRAL/Generators/[generator name]/examples

I don't want to make a pop up on the web page because this becomes a slippery slope of maintaining other hints for other generators. You may think "just for this one" but then I'll get "why not for this other one". Should a proper page be created I will gladly link to it from the web. This should definitely be discussed with the software group so I'll be there...

Fun fact: MCWrapper uses some find and replace to set certain options in a copy of the config file. If you use your own file without the keywords it will respect your decisions. This will result in anything from say the energy being improperly set to it flat out not working.

sdobbs commented 4 years ago

I understand there was some discussion about this yesterday, but I think that adding a link to https://github.com/JeffersonLab/gluex_MCwrapper/tree/master/Generators on the webpage is a good short-term solution. Pointing people towards the examples that exist is very reasonable, especially since you quote them above.

If you don't want to be responsible for maintaining these examples, GlueX should take that responsibility.

T-Britton commented 3 years ago

this has been done. There is a little question mark next to the generator config file which links to the github Generator examples