mesa icon indicating copy to clipboard operation
mesa copied to clipboard

GR1D output: wrongly placed documentation for deprecated feature?

Open mathren opened this issue 10 months ago • 1 comments

I had a vague memory that built-in in MESA there was the capability of outputting .short files to be used as input for GR1D, SNEC, other codes... grepping the entire code base for .short and/or GR1D I have the impression that this feature is deprecated (can't find the code that does the output) -- which is fine, it may be considered feature bloat to support any and all formats that exist out there.

I do find however the following line:

! ``'GR1D'`` ! Format for GR1D, defined in Sec. 3 of theGR1D documentation_.

as an option for the pulse_data_format. Regardless of whether we want to support this format or not, this is just incorrect, .short files are profile files, but not really useful for pulsations or asteroseismology. I think this is making this feature (if existing) non-findable by interested users, and is very misleading.

My personal opinion is that writing a parser for MESA output to convert to a .short file is not something that we need to support, and I propose to just cut those misleading lines from the docs (since the code seem to have disappeared anyways).

mathren avatar Mar 17 '25 20:03 mathren