The OPTIMADE Specification
View / Open Files
Authors
Andersen, Casper
Armiento, Rickard
Blokhin, Evgeny
Dwaraknath, Shyam
Evans, Matthew
Fekete, Adam
Gopakumar, Abhijith
Gražulis, Saulius
Hegde, Vinay
Horton, Matthew
Kumbhar, Snehal
Marzari, Nicola
Merkys, Andrius
Mohamed, Fawzi
Morris, Andrew
Oses, Corey
Pizzi, Giovanni
Purcell, Thomas
Rignanese, Gian-Marco
Scheffler, Matthias
Scheidgen, Markus
Talirz, Leopold
Toher, Cormac
Uhrin, Martin
Winston, Donald
Wolverton, Chris
Publication Date
2020-11-13Previous Version(s)
Type
Software
Metadata
Show full item recordCitation
Andersen, C., Armiento, R., Blokhin, E., Conduit, G., Dwaraknath, S., Evans, M., Fekete, A., et al. (2020). The OPTIMADE Specification [Software]. https://doi.org/10.17863/CAM.59903
Description
The Open Databases Integration for Materials Design (OPTIMADE) consortium aims to make materials databases interoperational by developing a common REST API. This repository contains the specification of the OPTIMADE API. $$ \ $$ * [optimade.rst](optimade.rst): The API specification. * [AUTHORS](AUTHORS): List of contributors. * [optimade.org](https://www.optimade.org): Public OPTIMADE web site * [OPTIMADE wiki](https://github.com/Materials-Consortia/OPTIMADE/wiki): Information for developers $$ \ $$ The subdirectory `schemas/` contains OpenAPI schemas for the main OPTIMADE API and index meta-database as implemented by the [optimade-python-tools repository](https://github.com/Materials-Consortia/optimade-python-tools). _Note_: These schemas are an approximation of the full human-readable specification and may be missing certain constraints. Furthermore, they may not be up to date in the develop branch of this repository. $$ \ $$ ## For developers $$ \ $$ The [master branch of the repository](https://github.com/Materials-Consortia/OPTIMADE/tree/master) is at the latest release or pre-release version of the specification. Versions without a version number suffix (alpha, beta, release candidates and similar) indicate a stable release. $$ \ $$ The [develop branch of the repository](https://github.com/Materials-Consortia/OPTIMADE/tree/develop) contains the present in-development version of the specification. $$ \ $$ API and client implementations are encouraged to support the latest release or pre-release of the specification. If this is a pre-release, implementations are also encouraged to support the latest stable release.
Keywords
Materials, API, Data
Relationships
Sponsorship
Royal Society (IMF130944)
Royal Society (uf130122)
Royal Society (RGF/EA/180034)
Royal Society (URF\R\201002)
Identifiers
External DOI: https://doi.org/10.5281/zenodo.4195051
This record's DOI: https://doi.org/10.17863/CAM.59903
Rights
Creative Commons Attribution 4.0 International, Creative Commons Attribution 4.0 International, Creative Commons Attribution 4.0 International