Index

A

adapter_from_providers() (in module httk.optimade) (in module httk.optimade.backend) (in module httk.optimade.backend.providers) add() (httk.optimade.backend.memory_store.MemorySearcher method) add_offset() (httk.optimade.backend.memory_store.MemorySearcher method) add_sort() (httk.optimade.backend.memory_store.MemorySearcher method) all_entries (httk.optimade.schema.served.ServedSchema attribute) always_false() (httk.optimade.backend.memory_store.MemoryVariable method) always_true() (httk.optimade.backend.memory_store.MemoryVariable method)

as_query_dict() (httk.optimade.model.request.ValidatedParameters method) (httk.optimade.model.ValidatedParameters method) (httk.optimade.ValidatedParameters method) available_licenses (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) available_licenses_for_entries (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute)

B

BackendAdapter (class in httk.optimade) (class in httk.optimade.backend) (class in httk.optimade.backend.adapter) baseurl (httk.optimade.model.RawRequest attribute) (httk.optimade.model.request.RawRequest attribute) (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.RawRequest attribute) (httk.optimade.ValidatedRequest attribute)

build_served_schema() (in module httk.optimade.schema.served)

C

contains() (httk.optimade.backend.memory_store.MemoryField method) content (httk.optimade.EndpointResponse attribute) (httk.optimade.model.EndpointResponse attribute) (httk.optimade.model.errors.OptimadeError attribute) (httk.optimade.model.OptimadeError attribute) (httk.optimade.model.request.EndpointResponse attribute) (httk.optimade.OptimadeError attribute) content_type (httk.optimade.EndpointResponse attribute) (httk.optimade.model.EndpointResponse attribute) (httk.optimade.model.request.EndpointResponse attribute) count() (httk.optimade.backend.execution.StoreResults method) (httk.optimade.backend.memory_store.MemorySearcher method) (httk.optimade.backend.protocols.QueryResults method) (httk.optimade.backend.QueryResults method) (httk.optimade.backend.StoreResults method) (httk.optimade.model.QueryResults method) (httk.optimade.model.results.QueryResults method)

create_app() (in module httk.optimade.runtime) (in module httk.optimade.runtime.asgi) create_asgi_app() (in module httk.optimade) (in module httk.optimade.api) cur (httk.optimade.backend.execution.StoreResults attribute) (httk.optimade.backend.StoreResults attribute)

D

data_available (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) database (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) default_response_fields (httk.optimade.schema.served.ServedSchema attribute)

determine_optimade_version() (in module httk.optimade.engine) (in module httk.optimade.engine.validate) dimension_slices (httk.optimade.model.request.ValidatedParameters attribute) (httk.optimade.model.ValidatedParameters attribute) (httk.optimade.ValidatedParameters attribute) dimensions (httk.optimade.backend.partial.PartialValue attribute) (httk.optimade.backend.PartialValue attribute)

E

encoding (httk.optimade.EndpointResponse attribute) (httk.optimade.model.EndpointResponse attribute) (httk.optimade.model.request.EndpointResponse attribute) endpoint (httk.optimade.model.RawRequest attribute) (httk.optimade.model.request.RawRequest attribute) (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.RawRequest attribute) (httk.optimade.ValidatedRequest attribute) EndpointResponse (class in httk.optimade) (class in httk.optimade.model) (class in httk.optimade.model.request)

endswith() (httk.optimade.backend.memory_store.MemoryField method) entry_info (httk.optimade.schema.served.ServedSchema attribute) entry_type_definition_from_simple() (in module httk.optimade.schema.served) EntrySource (class in httk.optimade) (class in httk.optimade.backend) (class in httk.optimade.backend.adapter) execute_query() (in module httk.optimade.backend) (in module httk.optimade.backend.execution)

F

fetch (httk.optimade.backend.partial.PartialValue attribute) (httk.optimade.backend.PartialValue attribute) field_handlers (httk.optimade.backend.adapter.BackendAdapter attribute) (httk.optimade.backend.BackendAdapter attribute) (httk.optimade.BackendAdapter attribute) FieldExtractor (in module httk.optimade.backend.adapter) fields (httk.optimade.backend.adapter.EntrySource attribute) (httk.optimade.backend.EntrySource attribute) (httk.optimade.EntrySource attribute)

filter (httk.optimade.model.request.ValidatedParameters attribute) (httk.optimade.model.ValidatedParameters attribute) (httk.optimade.ValidatedParameters attribute) format_optimade_error() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.error) format_value() (in module httk.optimade.backend.translation) fulltype_of() (in module httk.optimade.schema.served)

G

generate_base_endpoint_reply() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.info) generate_entry_endpoint_reply() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.entries) generate_entry_info_endpoint_reply() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.info) generate_info_endpoint_reply() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.info)

generate_links_endpoint_reply() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.info) generate_meta() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.meta) generate_partial_data_reply() (in module httk.optimade.endpoints.partial_data) generate_single_entry_endpoint_reply() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.entries) generate_versions_endpoint_reply() (in module httk.optimade.endpoints) (in module httk.optimade.endpoints.info)

H

has_any() (httk.optimade.backend.memory_store.MemoryField method) has_only() (httk.optimade.backend.memory_store.MemoryField method) httk.optimade module httk.optimade.api module httk.optimade.backend module httk.optimade.backend.adapter module httk.optimade.backend.execution module httk.optimade.backend.handlers module httk.optimade.backend.memory_store module httk.optimade.backend.partial module httk.optimade.backend.protocols module httk.optimade.backend.providers module httk.optimade.backend.translation module httk.optimade.endpoints module httk.optimade.endpoints.entries module httk.optimade.endpoints.error module httk.optimade.endpoints.info module httk.optimade.endpoints.meta module

httk.optimade.endpoints.partial_data module httk.optimade.engine module httk.optimade.engine.processing module httk.optimade.engine.validate module httk.optimade.filter module httk.optimade.model module httk.optimade.model.config module httk.optimade.model.errors module httk.optimade.model.request module httk.optimade.model.results module httk.optimade.model.versions module httk.optimade.runtime module httk.optimade.runtime.asgi module httk.optimade.runtime.devserver module httk.optimade.schema module httk.optimade.schema.served module httk.optimade.schema.trajectories module

I

implementation (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) include (httk.optimade.model.request.ValidatedParameters attribute) (httk.optimade.model.ValidatedParameters attribute) (httk.optimade.ValidatedParameters attribute)

include_paths (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute) InMemoryStore (class in httk.optimade) (class in httk.optimade.backend) (class in httk.optimade.backend.memory_store)

J

json_response (httk.optimade.EndpointResponse attribute) (httk.optimade.model.EndpointResponse attribute) (httk.optimade.model.request.EndpointResponse attribute)

L

length (httk.optimade.backend.partial.PartialDimension attribute) (httk.optimade.backend.PartialDimension attribute) license (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute)

limit (httk.optimade.backend.execution.StoreResults attribute) (httk.optimade.backend.StoreResults attribute) links (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) logger (in module httk.optimade.engine.processing)

M

MemoryExpression (class in httk.optimade.backend.memory_store) MemoryField (class in httk.optimade.backend.memory_store) MemorySearcher (class in httk.optimade.backend.memory_store) MemoryVariable (class in httk.optimade.backend.memory_store) module 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

more_data_available (httk.optimade.backend.execution.StoreResults attribute) (httk.optimade.backend.protocols.QueryResults attribute) (httk.optimade.backend.QueryResults attribute) (httk.optimade.backend.StoreResults attribute) (httk.optimade.model.QueryResults attribute) (httk.optimade.model.results.QueryResults attribute)

N

name (httk.optimade.backend.memory_store.MemoryField attribute) (httk.optimade.backend.partial.PartialDimension attribute) (httk.optimade.backend.PartialDimension attribute)

O

offset (httk.optimade.backend.execution.StoreResults attribute) (httk.optimade.backend.memory_store.MemorySearcher attribute) (httk.optimade.backend.StoreResults attribute) optimade_default_version (in module httk.optimade.model) (in module httk.optimade.model.versions) optimade_supported_versions (in module httk.optimade.model) (in module httk.optimade.model.versions)

OptimadeConfig (class in httk.optimade) (class in httk.optimade.model) (class in httk.optimade.model.config) OptimadeError, [1], [2] output() (httk.optimade.backend.memory_store.MemorySearcher method)

P

page_limit (httk.optimade.model.request.ValidatedParameters attribute) (httk.optimade.model.ValidatedParameters attribute) (httk.optimade.ValidatedParameters attribute) PAGE_LIMIT_MAX (in module httk.optimade.engine.validate) page_offset (httk.optimade.model.request.ValidatedParameters attribute) (httk.optimade.model.ValidatedParameters attribute) (httk.optimade.ValidatedParameters attribute) pairs (httk.optimade.backend.execution.StoreResults attribute) (httk.optimade.backend.StoreResults attribute) partial_data_chunk_size (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) partial_data_offset (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute) partial_data_parts (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute) PartialDimension (class in httk.optimade.backend) (class in httk.optimade.backend.partial) PartialValue (class in httk.optimade.backend) (class in httk.optimade.backend.partial) predicate (httk.optimade.backend.memory_store.MemoryExpression attribute)

Predicate (in module httk.optimade.backend.memory_store) process() (in module httk.optimade) (in module httk.optimade.engine) (in module httk.optimade.engine.processing) process_init() (in module httk.optimade) (in module httk.optimade.engine) (in module httk.optimade.engine.processing) properties_by_entry (httk.optimade.schema.served.ServedSchema attribute) property_definitions (httk.optimade.schema.served.ServedSchema attribute) property_metadata (httk.optimade.backend.adapter.EntrySource attribute) (httk.optimade.backend.EntrySource attribute) (httk.optimade.EntrySource attribute) (httk.optimade.model.ResultRow attribute) (httk.optimade.model.results.ResultRow attribute) property_metadata_requested (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute) provider (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) providers_from_registry() (in module httk.optimade) (in module httk.optimade.backend) (in module httk.optimade.backend.providers)

Q

query (httk.optimade.model.RawRequest attribute) (httk.optimade.model.request.RawRequest attribute) (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.RawRequest attribute) (httk.optimade.ValidatedRequest attribute) query_function() (httk.optimade.backend.adapter.BackendAdapter method) (httk.optimade.backend.BackendAdapter method) (httk.optimade.BackendAdapter method) QueryFunction (class in httk.optimade.backend) (class in httk.optimade.backend.protocols) (class in httk.optimade.model) (class in httk.optimade.model.results)

QueryResults (class in httk.optimade.backend) (class in httk.optimade.backend.protocols) (class in httk.optimade.model) (class in httk.optimade.model.results) querystr (httk.optimade.model.RawRequest attribute) (httk.optimade.model.request.RawRequest attribute) (httk.optimade.RawRequest attribute)

R

RawRequest (class in httk.optimade) (class in httk.optimade.model) (class in httk.optimade.model.request) recognized_prefixes (httk.optimade.backend.execution.StoreResults attribute) (httk.optimade.backend.StoreResults attribute) (httk.optimade.schema.served.ServedSchema attribute) recognized_response_fields (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute) RelatedResolver (in module httk.optimade.endpoints.entries) relationships (httk.optimade.backend.adapter.EntrySource attribute) (httk.optimade.backend.EntrySource attribute) (httk.optimade.EntrySource attribute) (httk.optimade.model.ResultRow attribute) (httk.optimade.model.results.ResultRow attribute) relurl (httk.optimade.model.RawRequest attribute) (httk.optimade.model.request.RawRequest attribute) (httk.optimade.RawRequest attribute) representation (httk.optimade.model.RawRequest attribute) (httk.optimade.model.request.RawRequest attribute) (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.RawRequest attribute) (httk.optimade.ValidatedRequest attribute) request_delay (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) request_id (httk.optimade.model.RawRequest attribute) (httk.optimade.model.request.RawRequest attribute) (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.RawRequest attribute) (httk.optimade.ValidatedRequest attribute)

RequestedSlice (class in httk.optimade.model.request) required_response_fields (httk.optimade.schema.served.ServedSchema attribute) response_code (httk.optimade.EndpointResponse attribute) (httk.optimade.model.EndpointResponse attribute) (httk.optimade.model.errors.OptimadeError attribute) (httk.optimade.model.OptimadeError attribute) (httk.optimade.model.request.EndpointResponse attribute) (httk.optimade.OptimadeError attribute) response_fields (httk.optimade.backend.execution.StoreResults attribute) (httk.optimade.backend.StoreResults attribute) (httk.optimade.model.request.ValidatedParameters attribute) (httk.optimade.model.ValidatedParameters attribute) (httk.optimade.ValidatedParameters attribute) response_format (httk.optimade.model.request.ValidatedParameters attribute) (httk.optimade.model.ValidatedParameters attribute) (httk.optimade.ValidatedParameters attribute) response_msg (httk.optimade.EndpointResponse attribute) (httk.optimade.model.EndpointResponse attribute) (httk.optimade.model.errors.OptimadeError attribute) (httk.optimade.model.OptimadeError attribute) (httk.optimade.model.request.EndpointResponse attribute) (httk.optimade.OptimadeError attribute) ResultRow (class in httk.optimade.model) (class in httk.optimade.model.results) Row (in module httk.optimade.backend.memory_store) run_dev_server() (in module httk.optimade.runtime) (in module httk.optimade.runtime.devserver)

S

schema (httk.optimade.backend.adapter.BackendAdapter attribute) (httk.optimade.backend.BackendAdapter attribute) (httk.optimade.BackendAdapter attribute) schema_url (httk.optimade.model.config.OptimadeConfig attribute) (httk.optimade.model.OptimadeConfig attribute) (httk.optimade.OptimadeConfig attribute) searcher() (httk.optimade.backend.InMemoryStore method) (httk.optimade.backend.memory_store.InMemoryStore method) (httk.optimade.InMemoryStore method) serve() (in module httk.optimade) (in module httk.optimade.api) ServedSchema (class in httk.optimade.schema.served) set_limit() (httk.optimade.backend.memory_store.MemorySearcher method) simplified_property() (in module httk.optimade.schema.served) sliceable (httk.optimade.backend.partial.PartialDimension attribute) (httk.optimade.backend.PartialDimension attribute) sort (httk.optimade.model.request.ValidatedParameters attribute) (httk.optimade.model.ValidatedParameters attribute) (httk.optimade.ValidatedParameters attribute)

sort_fields (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute) sort_keys (httk.optimade.backend.adapter.EntrySource attribute) (httk.optimade.backend.EntrySource attribute) (httk.optimade.EntrySource attribute) sortable_response_fields (httk.optimade.schema.served.ServedSchema attribute) sources (httk.optimade.backend.adapter.BackendAdapter attribute) (httk.optimade.backend.BackendAdapter attribute) (httk.optimade.BackendAdapter attribute) start (httk.optimade.model.request.RequestedSlice attribute) startswith() (httk.optimade.backend.memory_store.MemoryField method) step (httk.optimade.model.request.RequestedSlice attribute) stop (httk.optimade.model.request.RequestedSlice attribute) store (httk.optimade.backend.adapter.BackendAdapter attribute) (httk.optimade.backend.BackendAdapter attribute) (httk.optimade.BackendAdapter attribute) StoreResults (class in httk.optimade.backend) (class in httk.optimade.backend.execution)

T

tables (httk.optimade.backend.InMemoryStore attribute) (httk.optimade.backend.memory_store.InMemoryStore attribute) (httk.optimade.InMemoryStore attribute) target (httk.optimade.backend.adapter.EntrySource attribute) (httk.optimade.backend.EntrySource attribute) (httk.optimade.backend.memory_store.MemoryVariable attribute) (httk.optimade.EntrySource attribute)

trajectories_entry_info() (in module httk.optimade.schema.trajectories) translate_filter() (in module httk.optimade.backend) (in module httk.optimade.backend.translation) translate_filter_node() (in module httk.optimade.backend) (in module httk.optimade.backend.translation) translator_error_from() (in module httk.optimade.model.errors) TranslatorError, [1], [2]

U

unknown_response_fields (httk.optimade.backend.execution.StoreResults attribute) (httk.optimade.backend.StoreResults attribute) (httk.optimade.schema.served.ServedSchema attribute) unrecognized_response_fields (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute)

url_version (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute)

V

valid_endpoints (httk.optimade.schema.served.ServedSchema attribute) validate_optimade_request() (in module httk.optimade.engine) (in module httk.optimade.engine.validate) ValidatedParameters (class in httk.optimade) (class in httk.optimade.model) (class in httk.optimade.model.request) ValidatedRequest (class in httk.optimade) (class in httk.optimade.model) (class in httk.optimade.model.request)

values (httk.optimade.model.ResultRow attribute) (httk.optimade.model.results.ResultRow attribute) variable() (httk.optimade.backend.memory_store.MemorySearcher method) version (httk.optimade.model.RawRequest attribute) (httk.optimade.model.request.RawRequest attribute) (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.RawRequest attribute) (httk.optimade.ValidatedRequest attribute)

W

warnings (httk.optimade.model.request.ValidatedRequest attribute) (httk.optimade.model.ValidatedRequest attribute) (httk.optimade.ValidatedRequest attribute)