This is a fork of the optimade-python-tools modified and truncated for MPDD Database (phaseslab.com/mpdd) use.
The aim of OPTIMADE is to develop a common API, compliant with the JSON:API 1.0 specification. This is to enable interoperability among databases that serve crystal structures and calculated properties of existing and hypothetical materials.
Each release of the optimade
package from this repository only targets one version of the OPTIMADE specification, summarised in the table below.
- OPTIMADE Specification, the human-readable specification that this library is based on.
- optimade-validator-action, a GitHub action that can be used to validate implementations from a URL (using the validator from this repo).
- OpenAPI, the machine-readable format used to specify the OPTIMADE API in
openapi.json
andindex_openapi.json
. - Interactive documentation generated from
openapi.json
(see also interactive JSON editor). - pydantic, the library used for generating the OpenAPI schema from Python models.
- FastAPI, the framework used for generating the reference implementation expressed by the
openapi.json
specification. - Lark, the library used to parse the filter language in OPTIMADE queries.