Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Development documentation (dev:main) — content may differ from any release.
httk-optimade dev:main documentation
httk-optimade dev:main documentation

Documentation

  • Serving entry providers
  • Examples
    • A small OPTIMADE demo server over an in-memory dataset.
    • Standing up a backend from plain dict rows, without writing a provider
    • A minimal OPTIMADE server fed by an httk-core entry provider.
    • Walking a live OPTIMADE API in-process, without binding a port
  • Walking an OPTIMADE API in-process
  • Reference
    • httk.optimade
      • httk.optimade.api
      • httk.optimade.backend
        • httk.optimade.backend.adapter
        • httk.optimade.backend.execution
        • httk.optimade.backend.handlers
        • httk.optimade.backend.memory_store
        • httk.optimade.backend.partial
        • httk.optimade.backend.protocols
        • httk.optimade.backend.providers
        • httk.optimade.backend.translation
      • httk.optimade.endpoints
        • httk.optimade.endpoints.entries
        • httk.optimade.endpoints.error
        • httk.optimade.endpoints.info
        • httk.optimade.endpoints.meta
        • httk.optimade.endpoints.partial_data
      • httk.optimade.engine
        • httk.optimade.engine.processing
        • httk.optimade.engine.validate
      • httk.optimade.filter
      • httk.optimade.model
        • httk.optimade.model.config
        • httk.optimade.model.errors
        • httk.optimade.model.request
        • httk.optimade.model.results
        • httk.optimade.model.versions
      • httk.optimade.runtime
        • httk.optimade.runtime.asgi
        • httk.optimade.runtime.devserver
      • httk.optimade.schema
        • httk.optimade.schema.served
        • httk.optimade.schema.trajectories
  • How it works
  • API Reference
    • httk.optimade
      • httk.optimade.api
      • httk.optimade.backend
        • httk.optimade.backend.adapter
        • httk.optimade.backend.execution
        • httk.optimade.backend.handlers
        • httk.optimade.backend.memory_store
        • httk.optimade.backend.partial
        • httk.optimade.backend.protocols
        • httk.optimade.backend.providers
        • httk.optimade.backend.translation
      • httk.optimade.endpoints
        • httk.optimade.endpoints.entries
        • httk.optimade.endpoints.error
        • httk.optimade.endpoints.info
        • httk.optimade.endpoints.meta
        • httk.optimade.endpoints.partial_data
      • httk.optimade.engine
        • httk.optimade.engine.processing
        • httk.optimade.engine.validate
      • httk.optimade.filter
      • httk.optimade.model
        • httk.optimade.model.config
        • httk.optimade.model.errors
        • httk.optimade.model.request
        • httk.optimade.model.results
        • httk.optimade.model.versions
      • httk.optimade.runtime
        • httk.optimade.runtime.asgi
        • httk.optimade.runtime.devserver
      • httk.optimade.schema
        • httk.optimade.schema.served
        • httk.optimade.schema.trajectories
Back to top
View this page

Examples¶

Runnable scripts from the repository’s examples/ directory.

  • A small OPTIMADE demo server over an in-memory dataset.
  • Standing up a backend from plain dict rows, without writing a provider
  • A minimal OPTIMADE server fed by an httk-core entry provider.
  • Walking a live OPTIMADE API in-process, without binding a port
Next
A small OPTIMADE demo server over an in-memory dataset.
Previous
Serving entry providers
Copyright © 2026, The httk-optimade AUTHORS
Made with Sphinx and @pradyunsg's Furo