Dev Setup¶

Clone the meta-hq repository:

Through https:

git clone https://github.com/krishnanlab/meta-hq.git

Through ssh:

git clone git@github.com:krishnanlab/meta-hq.git

Install Git LFS¶

The data packages and some of the raw annotation sources are too large to be tracked through native git. We use Git LFS to track these large files. You can install Git-LFS at https://git-lfs.com.

To download lfs tracked files run:

git lfs install
git-lfs fetch --all
git lfs checkout

Install packages¶

We highly recommend using uv for install. The meta-hq repository is a structured as a monorepo uv workspace with the metahq-cli and metahq-core packages in packages/cli and packages/core, respectively.

With Make:

Through uv:

make uv_dev

Through pip:

make dev

Manually:

Through pip:

cd packages/core
pip install -e ".[dev]"

cd ../cli
pip install -e ".[dev]"

Configure the package¶

Download the database and configure both packages.

metahq setup

Local documentation build¶

To build and render the documentation page locally run:

mkdocs serve