httk-serve is a httk₂ distribution providing a generic implementation of the OPTIMADE protocol; the entry schemas it serves are supplied by providers (such as httk-atomistic's structure provider) through the neutral httk.core.EntryProvider contract.
The served API version is OPTIMADE v1.3.0. Implemented optional parts of the
specification include sorting, the references, files, and trajectories entry types,
relationships with the include query parameter, per-property metadata, the partial data
protocol (JSON Lines format and dimension_slices) with the compact list representation,
and the license/available_licenses/warnings meta and base-info fields. Optional parts
that remain unimplemented: cross-source sort merging, filtering on relationship
.target.*/.description/.role properties, the sparse JSON Lines layout, index
meta-databases, and rejection of unrecognized query parameters. See
docs/optimade/how_it_works.md for the protocol architecture and backend/web seams.
The implementation was ported from the OPTIMADE server in httk v1 (which served OPTIMADE
v1.0.0) and then upgraded to v1.3.0. The legacy client-side validation/ subpackage has
intentionally not been ported; use the official
optimade-validator tool
to check conformance of a running server.
httk.serve.web provides Jinja2 rendering, legacy .httkweb compatibility,
static publication, and an ASGI runtime. Its trusted widgets include
httk.serve.table for provider-backed pagination and
httk.serve.optimade_table for browser-side OPTIMADE access. Use
httk serve web serve, httk serve web check, or httk serve web list.