Materials-Consortia / Materials-Consortia/optimade-python-tools
Add support for partial data format to Optimade python tools.
Open
@JPBergsma is already working on this.
Since Aug 4, 2023.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
After the last optimade workshop, the option to return data in parts was added to the OPTIMADE specification. OPTIMADE PR#467
With this issue, I would like to keep track of the different steps needed to implement this in the optimade-python-tools.
- Create a pydantic model of the partial data response format.
- Add code to convert python object to appropriate jsonlines response.
- Add validators
- Add unit tests for validator model and jsonlines response generator.
- Add example data
- Add code to recognize a property should be returned as partial data and correctly split up data in this case.
- Add/Update integration tests
Questions ?
It would seem logical to store data/files in Grid FS of MongoDB. Do we want to enable this by default or make it optional ?
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.