Installation Guide¶

Install from Docker Hub¶

The recommended way to install TraitHorizon is via Docker. You can run a traithorizon container with a single command:

docker run -it -p 5555:5555 -v [HOST_DIRECTORY]:[CONTAINER_DIRECTORY] histotools/traithorizon:main /bin/bash

Note

Replace [HOST_DIRECTORY] and [CONTAINER_DIRECTORY] with the appropriate paths on your host and in the container, respectively. For an example use case, you can omit the -v flag altogether to run the container without mounting any directories.

This will pull the latest image from the TraitHorizon DockerHub repository and start a new container with an interactive terminal for running TraitHorizon commands. Please see the User Guide section for instructions on how to use TraitHorizon.

Install using pip¶

While we recommend using Docker for most users, some may prefer installing TraitHorizon from source for development or customization purposes.

Note

TraitHorizon has been tested using Python 3.10 and may not be compatible with other versions.

Follow these steps to install and set up TraitHorizon:

Clone the Repository

Clone the TraitHorizon repository to your local machine:

git clone https://github.com/choosehappy/TraitHorizon.git
cd TraitHorizon

(Optional) Set Up a Virtual Environment

It is recommended to use a virtual environment to manage dependencies:
```
python3 -m venv venv
source venv/bin/activate
```
Install Dependencies

Install TraitHorizon
```
pip install .
```
Verify Installation

Run the following command to verify that TraitHorizon is installed correctly:
```
traithorizon --help
```
This should display the CLI usage instructions.

Next Steps¶

Once installed, proceed to the User Guide section to learn how to use TraitHorizon.