Installation¶

Note

Python 3.8 or later is required.

pip install¶

The easiest way to install refidx is with pip:

pip install refidx

To install refidx from source, first clone the repository:

git clone https://gitlab.com/benvial/refidx.git

Then, install using pip:

cd refidx
pip install .

If you want to contribute to refidx, you might want to install it in editable mode:

cd refidx
pip install -e .

To install all the packages needed for development, testing and documentation, run:

make dev
make test-req
make doc-req

To update the database:

make dldb
make gendb

To run all tests, run:

make test

To build the gallery, run:

make gengallery

To build the documentation, run:

make doc