Materials-Consortia / Materials-Consortia/optimade-python-tools

Do we want to declare nested provider-specific properties in the config file?

Open
#1,265 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

In the section database-provider-specific properties it is described that databases are allowed to add provider specific fields to OPTIMADE dictionary fields, such as adding _exmpl_oxidation_state to the species dictionaries.
Do we want to support declaring such properties in the config file?
It may be useful, for example, for adding extra fields to the species dictionary, which may be needed for the implementing a OPTIMADE database for BIoexcel.

If so, what syntax should we use for the field name?
Do you think there will be a problem with a name like "species.oxidation_state" to declare that there is a provider specific property within species?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the database-provider-specific properties section in optimade.rst and trace how the configuration file is documented or handled. Determine whether nested provider-specific properties should be declared and what field-name syntax would represent them; done requires a decided, documented approach.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.