Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow provider field descriptions to be provided in the config #1095

Closed
ml-evs opened this issue Mar 4, 2022 · 0 comments · Fixed by #1096
Closed

Allow provider field descriptions to be provided in the config #1095

ml-evs opened this issue Mar 4, 2022 · 0 comments · Fixed by #1096

Comments

@ml-evs
Copy link
Member

ml-evs commented Mar 4, 2022

Currently if you want to describe a provider field in the relevant /info/<endpoint> endpoint, you have to add it explicitly to a pydantic model.

Instead of a simple list of provider fields like provider_fields = {"structures": ["volume", "band_gap"], we should also allow something like

provider_fields = {
    "structures": [
            {"name": "volume", "description": "The cell volume", "units": "A^3"}, 
            {"name": "band_gap", "description": "The band gap", "units": "eV"}
    ]
}

s.t. the description/units etc. can be propagated to the relevant info endpoint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant