Resources

Grouped by what you are trying to do. If you only want to search some data, start with the clients instead.

Read the specification

What	Where
Specification, latest release	`optimade.rst` on `master`
Specification, in development	`optimade.rst` on `develop`
Release history	Changelog
Machine-readable schema	OpenAPI schema in Swagger UI
Permanent schema URLs	`schemas`
Notes and design discussion	Developer wiki

Which version to implement, and how the master and develop branches are used, is covered on the API specification page.

Maintained by the consortium, unless noted otherwise.

Serve an OPTIMADE API

Tool	What it does
`optimade-python-tools`	The reference implementation: a server and a Python library
`optimade-maker`	Turns static data files into an OPTIMADE API

Query across databases

Tool	What it does
`optimade-gateway`	One API that federates queries to many OPTIMADE databases
Clients	Web, command-line and Python clients, compared side by side

Validate an implementation

Tool	What it does
`optimade-validator`	Command-line validator, shipped with `optimade-python-tools`
`optimade-validator-action`	Runs that validator against your API on every commit

Step	Where
Add yourself to `providers.json`	`providers` repository
The published providers list	providers.optimade.org

Once registered, your database is discoverable by every client above, and appears on the providers dashboard.

What	Where
Who serves what, and which version	Providers dashboard
Uptime monitoring	status.optimade.org

Resource	What it is
`optimade-tutorial-exercises`	An open-ended set of exercises, first prepared for the NOMAD Virtual Tutorial Series