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-core dev:main documentation
httk-core dev:main documentation

Documentation

  • Reference
    • httk.core
      • httk.core.building
      • httk.core.citations
      • httk.core.cli
      • httk.core.converting
      • httk.core.crypto
      • httk.core.data_records
      • httk.core.dataset_loader
      • httk.core.datasets
      • httk.core.datastream
        • httk.core.datastream.bytestream_api
        • httk.core.datastream.bytestream_backend
        • httk.core.datastream.bytestream_bytes
        • httk.core.datastream.bytestream_bytes_view
        • httk.core.datastream.bytestream_common
        • httk.core.datastream.bytestream_file
        • httk.core.datastream.bytestream_file_view
        • httk.core.datastream.bytestream_filename
        • httk.core.datastream.bytestream_filename_view
        • httk.core.datastream.bytestream_like
        • httk.core.datastream.bytestream_request
        • httk.core.datastream.bytestream_request_view
        • httk.core.datastream.bytestream_url
        • httk.core.datastream.bytestream_url_view
        • httk.core.datastream.bytestream_view
        • httk.core.datastream.compression
        • httk.core.datastream.datastream_url
        • httk.core.datastream.network_policy
        • httk.core.datastream.textstream_api
        • httk.core.datastream.textstream_backend
        • httk.core.datastream.textstream_common
        • httk.core.datastream.textstream_file
        • httk.core.datastream.textstream_file_view
        • httk.core.datastream.textstream_filename
        • httk.core.datastream.textstream_filename_view
        • httk.core.datastream.textstream_like
        • httk.core.datastream.textstream_request
        • httk.core.datastream.textstream_request_view
        • httk.core.datastream.textstream_string
        • httk.core.datastream.textstream_string_view
        • httk.core.datastream.textstream_url
        • httk.core.datastream.textstream_url_view
        • httk.core.datastream.textstream_view
      • httk.core.digests
      • httk.core.docs
        • httk.core.docs.cli
        • httk.core.docs.config
        • httk.core.docs.ecosystem
        • httk.core.docs.gitsite
        • httk.core.docs.inventories
        • httk.core.docs.lockfile
        • httk.core.docs.manifests
        • httk.core.docs.redirect
        • httk.core.docs.release
        • httk.core.docs.semver
        • httk.core.docs.sitetree
        • httk.core.docs.sphinx_ext
      • httk.core.entry_provider
      • httk.core.entry_types
      • httk.core.exactmath
      • httk.core.fetching
      • httk.core.files
      • httk.core.loading
      • httk.core.memguard
      • httk.core.optimade
        • httk.core.optimade.entries
        • httk.core.optimade.filter
          • httk.core.optimade.filter.parser
        • httk.core.optimade.resources
      • httk.core.plugins
        • httk.core.plugins.cli
        • httk.core.plugins.install
        • httk.core.plugins.installed
        • httk.core.plugins.manifest
      • httk.core.precision
      • httk.core.project
        • httk.core.project.anchor
        • httk.core.project.cli
        • httk.core.project.seal
        • httk.core.project.templates
      • httk.core.property_definitions
      • httk.core.provenance
      • httk.core.register
        • httk.core.register.cli
        • httk.core.register.entries
        • httk.core.register.io
        • httk.core.register.schemas
      • httk.core.report
      • httk.core.saving
      • httk.core.schema_check
      • httk.core.services
      • httk.core.storage
        • httk.core.storage.identity
        • httk.core.storage.markers
        • httk.core.storage.rational_text
        • httk.core.storage.stored_properties
      • httk.core.userdirs
      • httk.core.validation
        • httk.core.validation.iris
      • httk.core.vectors
        • httk.core.vectors.fracvector
        • httk.core.vectors.leaf_codecs
        • httk.core.vectors.mutablefracvector
        • httk.core.vectors.numeric
        • httk.core.vectors.scalar_like
        • httk.core.vectors.surdvector
        • httk.core.vectors.vector_api
        • httk.core.vectors.vector_backend
        • httk.core.vectors.vector_frac_view
        • httk.core.vectors.vector_like
        • httk.core.vectors.vector_native_backend
        • httk.core.vectors.vector_native_view
        • httk.core.vectors.vector_numpy_backend
        • httk.core.vectors.vector_numpy_view
        • httk.core.vectors.vector_surd_view
        • httk.core.vectors.vector_view
        • httk.core.vectors.vectormath
      • httk.core.views
        • httk.core.views.backend
        • httk.core.views.coercion
        • httk.core.views.unviewing
        • httk.core.views.unwrapping
        • httk.core.views.view
  • Views and Backends
  • Module registry
  • Datastreams
  • The extensible command line
  • Plugins
  • Cryptography
  • Projects
  • Property definitions
  • Vectors
  • Exact math on rationals and decimals
  • Citation credits
  • Examples
    • Datastreams quickstart
    • Vectors quickstart
    • Exact math quickstart
    • Getting data into httk: the load dispatcher and the DatasetLoader
    • Building a custom OPTIMADE entry type end to end
    • Implementing an EntryProvider: the contract httk-core owns
    • Parsing OPTIMADE filter strings into an abstract syntax tree
    • Coercion quickstart

Details

  • Views and Backends in detail
  • Module registry in detail
  • Datastreams in detail
  • Plugins in detail
  • Property definitions
  • Vectors in detail
  • Exact math in detail
  • API Reference
    • httk.core
      • httk.core.building
      • httk.core.citations
      • httk.core.cli
      • httk.core.converting
      • httk.core.crypto
      • httk.core.data_records
      • httk.core.dataset_loader
      • httk.core.datasets
      • httk.core.datastream
        • httk.core.datastream.bytestream_api
        • httk.core.datastream.bytestream_backend
        • httk.core.datastream.bytestream_bytes
        • httk.core.datastream.bytestream_bytes_view
        • httk.core.datastream.bytestream_common
        • httk.core.datastream.bytestream_file
        • httk.core.datastream.bytestream_file_view
        • httk.core.datastream.bytestream_filename
        • httk.core.datastream.bytestream_filename_view
        • httk.core.datastream.bytestream_like
        • httk.core.datastream.bytestream_request
        • httk.core.datastream.bytestream_request_view
        • httk.core.datastream.bytestream_url
        • httk.core.datastream.bytestream_url_view
        • httk.core.datastream.bytestream_view
        • httk.core.datastream.compression
        • httk.core.datastream.datastream_url
        • httk.core.datastream.network_policy
        • httk.core.datastream.textstream_api
        • httk.core.datastream.textstream_backend
        • httk.core.datastream.textstream_common
        • httk.core.datastream.textstream_file
        • httk.core.datastream.textstream_file_view
        • httk.core.datastream.textstream_filename
        • httk.core.datastream.textstream_filename_view
        • httk.core.datastream.textstream_like
        • httk.core.datastream.textstream_request
        • httk.core.datastream.textstream_request_view
        • httk.core.datastream.textstream_string
        • httk.core.datastream.textstream_string_view
        • httk.core.datastream.textstream_url
        • httk.core.datastream.textstream_url_view
        • httk.core.datastream.textstream_view
      • httk.core.digests
      • httk.core.docs
        • httk.core.docs.cli
        • httk.core.docs.config
        • httk.core.docs.ecosystem
        • httk.core.docs.gitsite
        • httk.core.docs.inventories
        • httk.core.docs.lockfile
        • httk.core.docs.manifests
        • httk.core.docs.redirect
        • httk.core.docs.release
        • httk.core.docs.semver
        • httk.core.docs.sitetree
        • httk.core.docs.sphinx_ext
      • httk.core.entry_provider
      • httk.core.entry_types
      • httk.core.exactmath
      • httk.core.fetching
      • httk.core.files
      • httk.core.loading
      • httk.core.memguard
      • httk.core.optimade
        • httk.core.optimade.entries
        • httk.core.optimade.filter
          • httk.core.optimade.filter.parser
        • httk.core.optimade.resources
      • httk.core.plugins
        • httk.core.plugins.cli
        • httk.core.plugins.install
        • httk.core.plugins.installed
        • httk.core.plugins.manifest
      • httk.core.precision
      • httk.core.project
        • httk.core.project.anchor
        • httk.core.project.cli
        • httk.core.project.seal
        • httk.core.project.templates
      • httk.core.property_definitions
      • httk.core.provenance
      • httk.core.register
        • httk.core.register.cli
        • httk.core.register.entries
        • httk.core.register.io
        • httk.core.register.schemas
      • httk.core.report
      • httk.core.saving
      • httk.core.schema_check
      • httk.core.services
      • httk.core.storage
        • httk.core.storage.identity
        • httk.core.storage.markers
        • httk.core.storage.rational_text
        • httk.core.storage.stored_properties
      • httk.core.userdirs
      • httk.core.validation
        • httk.core.validation.iris
      • httk.core.vectors
        • httk.core.vectors.fracvector
        • httk.core.vectors.leaf_codecs
        • httk.core.vectors.mutablefracvector
        • httk.core.vectors.numeric
        • httk.core.vectors.scalar_like
        • httk.core.vectors.surdvector
        • httk.core.vectors.vector_api
        • httk.core.vectors.vector_backend
        • httk.core.vectors.vector_frac_view
        • httk.core.vectors.vector_like
        • httk.core.vectors.vector_native_backend
        • httk.core.vectors.vector_native_view
        • httk.core.vectors.vector_numpy_backend
        • httk.core.vectors.vector_numpy_view
        • httk.core.vectors.vector_surd_view
        • httk.core.vectors.vector_view
        • httk.core.vectors.vectormath
      • httk.core.views
        • httk.core.views.backend
        • httk.core.views.coercion
        • httk.core.views.unviewing
        • httk.core.views.unwrapping
        • httk.core.views.view
    • httk.registry.cli.core
    • httk.registry.entries.core
    • httk.registry.schemas.core
Back to top
View this page

Reference¶

This section documents the supported public API.

  • httk.core
    • Submodules
    • Attributes
    • Classes
    • Functions
    • Package Contents
Next
httk.core
Previous
Home
Copyright © 2026, The httk-core AUTHORS
Made with Sphinx and @pradyunsg's Furo