GR1D output: wrongly placed documentation for deprecated feature?
- Dominant language
- Fortran
- Stars
- 249
- Forks
- 82
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 3
Description
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 the `GR1D 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).
Contributor guide
Research direction
Search the codebase for the exact `pulse_data_format` and `GR1D` documentation text, then check whether any `.short` output implementation remains. Remove the misleading GR1D entry if the output code is absent, and confirm the documentation no longer presents `.short` files as a pulse-data format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fortran
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100