Materials-Consortia / Materials-Consortia/optimade-python-tools
MongoDB cache
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
In a discussion with @CasperWA and @giovannipizzi, we thought that it would be good to have the option to store the cartesian site positions and the species_at_sites fields outside MongoDB and only store a link to this data in the MongoDB. This would mean that the Mongo database would be smaller and would more easily fit in the memory or even the cache memory of the server thereby improving the speed of searches.
It would be nice if functions, that could automatically retrieve this data from files, could be added to the optimade-python tools.
This will be especially useful after the trajectory endpoint has been added to the OPTIMADE standard, as trajectories are much larger than structures.
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
No files, tests, or entry points are named. Start by locating the MongoDB storage handling in optimade-python tools, then determine the scope for storing cartesian site positions and species_at_sites externally and retrieving them automatically; done should include a defined storage-link workflow that reduces MongoDB document size.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- mongodb, python
- Domain
- backend, databases
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100