search

TeamCOMPAS / COMPAS

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

Documentation on Record Types #1131

Closed ilyamandel closed 1 month ago

ilyamandel commented 1 month ago

It is challenging to find documentation on the variable called Record_Type [BSE_DETAILED_RECORD_TYPE] in the detailed output. It's technically there at https://compas.readthedocs.io/en/latest/pages/User%20guide/Program%20options/program-options-list-defaults.html , but it's not an obvious place to look for output info (and even there, the record name as used in the CSV/HDF5 files is not explicitly mentioned).

Generally, the documentation should make it easy for users to link the names of the output columns they have access to with the description of those outputs (i.e., we should consider the use case of a user finding a promising column name and wanting to find out exactly what the contents mean).

ilyamandel commented 1 month ago

Addressed in #1140 , closing.