Add memcheck (and similar) tutorials and links to developer guide
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 287
- Forks
- 109
- Avg merge
- 4d 41m
- Merged PRs (30d)
- 5
Description
What needs to be documented?
It would be nice to provide some tips for new developers in using memcheck, totalview, nsight compute, etc., with GEOSX. This could likely be a very short section with GEOSX-specific flags / use-patterns, and then a link to external generic tutorials.
What sort of documentation would help?
DeveloperGuide
What are the deficiencies of the existing documentation?
We will likely have a growing team of new-ish developers who are not experienced with advanced debugging, memory-check, and performance tools. Any pointers to get people started would be useful, and may help take some of the burden off the core development team.
Additional notes or context
Other suggestions or discussion welcome.
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.