search

TeamCOMPAS / COMPAS

COMPAS rapid binary population synthesis code
http://compas.science
MIT License
65 stars 66 forks source link

Document code defaults more clearly #582

Closed ilyamandel closed 1 year ago

ilyamandel commented 3 years ago

We have a few cases where pythonSubmit specifies multiple options in which one over-rides the other, e.g., for metallicity vs. metallicity distribution. Meanwhile, there are a few places in Options.cpp where defaults appear only as defensive programming and will never be used, e.g., m_metallicity is always over-ridden either by a user-specified metallicity on the command line, or by the (default or user specified) metallicity distribution.

In the future, we could improve code documentation to clarify which options will be used and which get over-ridden in the C++ code. Meanwhile, in pythonSubmit, we could comment out unused options, with a comment that this option exists (and can be modified), but will not be used unless another option is commented out.

avigna commented 2 years ago

(Would need to check if the current yaml file implementation of the options partially help with this issue)

ilyamandel commented 1 year ago

I think this has mostly been addressed by other changes in the meantime, so labelling "won't fix".

ilyamandel commented 1 year ago

Closing since nobody objected to the "won't fix" status. :)