Create provenance class
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 196
- Forks
- 34
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 11
Description
I would like to create a provenance class in core that helps track configuration options, TPL versions, and enabled capabilities. In Serac we build up basic information than copy/paste that logic into Smith and build upon it. It would be nice to have that capability encapsulated in a class in Axom and use it for Axom as well.
For example:
// serac
Provenance serac;
serac.library("hdf5", "0.1.1");
serac.capability("lumberjack_logging", true);
serac.configuration("cuda", false);
// smith
Provenance smith(serac);
smith.library("some_fancy_library", "2.0.1");
// prints both serac and smiths provenance information together
SLIC_INFO(smith.to_string());
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.
Research direction
The issue names Axom's core and shows provenance logic currently copied between Serac and Smith, but it names no files or tests. Start by locating those existing implementations and comparing the required configuration, library/TPL, capability, inheritance, and serialization behavior. Done means an agreed Provenance API is implemented for Axom and usable by its consumers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100