Refresh OPTIMADE aliases and update docstrings #3447
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Apropos of nothing in particular... here is PR that makes some updates to the OPTIMADE client (and maybe starts a discussion about its future).
Major changes:
Happy to talk about how we could integrate the models and client at optimade-python-tools if that would be preferable. It would allow for async pulling data from all databases, pre-flight validating filters and validating responses (dangerous stuff for some databases...) and the code here could focus on just making sure the returned objects work with pymatgen. Should be releasing o-p-t v1.0 (Materials-Consortia/optimade-python-tools#1831) before the end of the year which will support pydantic v2 and hopefully have better isolation, so wouldn't require many additional deps (httpx for async requests, Lark for parsing filters: see here)
Checklist
ruff
.mypy
.duecredit
@due.dcite
decorators to reference relevant papers by DOI (example)