Installation
============

Requirements
------------

* Python 3.12+
* pip

Install from PyPI
-----------------

.. code-block:: bash

   pip install zvec-db

Install from source
-------------------

.. code-block:: bash

   git clone https://github.com/ccdv-ai/zvec-db.git
   cd zvec-db
   pip install -e ".[test]"

Dependencies
------------

zvec-db depends on the following packages:

* zvec
* scikit-learn
* numpy
* scipy

Test dependencies
-----------------

To install the test suite:

.. code-block:: bash

   pip install "zvec-db[test]"

This will install:

* pytest
* pytest-cov