Materials-Consortia / Materials-Consortia/optimade-python-tools
How to handle properties with domain specific prefixes?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
In the discussions about the new bio fields (see OPTIMADE issue #389), the idea came up to have domain specific prefixes.
For example, "biomol" for fields in the biomolecular domain.
I am now wondering what the best way to accommodate this in the Optimade python tools would be.
I could declare them in the trajectory and structure models, but I am not sure what kind of consequences this would have, you do not want the biomol fields to be visible for all the Optimade servers.
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 the trajectory and structure models mentioned in the issue, then review OPTIMADE issue #389 for the domain-specific prefix discussion. Trace how model fields become visible to OPTIMADE servers and document the consequences of declaring biomolecular fields there. Done requires an agreed approach for accommodating prefixed properties without exposing them universally.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100