Lack of documentation of GEOS ouputs
@MelReyCG is already working on this.
Since Jun 6, 2025.
- #3709 by @amandinehry — closed without merging
- Dominant language
- C++
- Stars
- 287
- Forks
- 109
- Avg merge
- 4d 41m
- Merged PRs (30d)
- 5
Description
What needs to be documented?
- A clear definition of each output of GEOS (csv and log and HDF5) is needed
- Calculation method of each output
What sort of documentation would help?
As an example, we have the outputs of the compositional Multiphase Statistics in the form of csv and log but there is no documentation of each output. What's lacking also is the physical meaning of each output and also an explanation of how these ouputs are computed.
What are the deficiencies of the existing documentation?
Currently, no documentation is available
Additional notes or context
As an example, the attached csv is an output of compositional Multiphase Statistics and it was difficult to know how the total injected CO2 mass was calculated and also to understand the physical meaning of the other outputs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.