NWChemEx / NWChemEx/PluginPlay
Cache tags
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 13
- Forks
- 1
- Avg merge
- 43m
- Merged PRs (30d)
- 4
Description
This issue is created to follow up on the features @ryanmrichard pointed out during PR #199. Copying from there:
- start a class, say CacheEntry which is just a tag and the pluginplay::detail_::Any instance associated with the tag. See https://github.com/NWChemEx-Project/PluginPlay/pull/199#discussion_r727483539.
- some other possible tags are:
- compress (data can be compressed to save room, but should remain on the heap)
- archive (it can be written to disk)
Down the road we could conceivably do some of this automatically by timing how long the module took to run and determining if it's worth saving/compressing the data vs. rerunning the module. See https://github.com/NWChemEx-Project/PluginPlay/pull/199#issuecomment-941531983.
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
Start by reading PR #199, especially the linked discussion and issue comment, to understand the proposed cache-tag behavior. Define what the CacheEntry tag and associated pluginplay::detail_::Any instance must represent, then clarify the intended compress and archive tags and their completion criteria with maintainers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- performance
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100