httk-core¶
This site documents specifically the httk-core module. For the full documentation of httk₂ as a whole, see docs.httk.org.
httk-core is a thin module providing core functionality for httk₂.
It also defines the neutral httk.core.EntryProvider contract and its registry
(register_entry_provider), by which domain modules supply described, queryable
entry types to consumers such as httk-optimade without either side depending
on the other.
Quick links
API reference: Reference
Views and backends guide: Views and Backends
Datastream guide: Datastreams
OPTIMADE definitions & entry providers: OPTIMADE property & entry-type definitions
Exact math on rationals and decimals: Exact math on rationals and decimals
Vectors guide: Vectors
Examples notebook: Examples
Install¶
Preferably work in a Python virtual environment, then do:
git clone https://github.com/httk/httk-core
cd httk-core
python -m pip install -e .
Usage (tiny example)¶
from httk.core import subpackages
print(subpackages)