Installation¶
Install from PyPI¶
Note
As of Winter 2024, finch is available as a PyPI-based package for testing and evaluation purposes. For a production server, we recommend deploying Finch as a Docker service.
To install the latest release from PyPI:
$ python -m pip install birdhouse-finch
Install from Docker¶
The easiest way to deploy Finch is to use the Docker image. The Docker image is available on Docker Hub as birdhouse/finch.
$ docker pull birdhouse/finch:latest
Development Installation (GitHub)¶
Check out code from the Finch GitHub repo and start the installation:
$ git clone https://github.com/bird-house/finch.git
$ cd finch
Create Conda environment named finch:
$ conda env create -f environment.yml
$ source activate finch
Install Finch app:
$ python -m pip install -e .
OR
$ make install
For development you can use this command:
$ pip install -e .[dev]
OR
$ make develop
Install from Conda¶
Note
finch is not yet available on conda-forge. But we are working on making this package available soon!