Installation

Requirements

• Python 3.10 or later
• A C compiler (gcc or clang) to build the native libhypermesh extension
• Linux x86-64, macOS arm64/x86-64, or any POSIX system

Install from PyPI

pip install hypermeshdb

The package ships with pre-compiled wheels for Linux x86-64 and macOS arm64. On other platforms, pip install will build the C extension from source (requires gcc).

Install from source

git clone https://github.com/yourorg/hypermesh-workbench.git
cd hypermesh-workbench
pip install -e ".[dev]"

This installs the package in editable mode with all development dependencies (pytest, httpx, numpy, scipy).

Verify the installation

import hypermeshdb
print(hypermeshdb.__version__)
db = hypermeshdb.connect("/tmp/verify_install")
print(db.execute("CALL SHOW_HYPEREDGE_TABLES() RETURN *"))

TypeScript / Node.js SDK

npm install @hypermeshdb/client

Requires Node.js 18 or later (for native fetch).

Docker

docker pull hypermeshdb/server:latest
docker run -p 8000:8000 \
  -v /your/data:/data \
  -e HMDB_API_KEY=hmdb_yoursecretkey \
  hypermeshdb/server

See the Docker guide for full compose configuration with TLS, volumes, and Kubernetes readiness/liveness probes.