Skip to content

Installation guide

Nadia Tahiri edited this page Sep 20, 2024 · 8 revisions

Welcome to aPhyloGeo! This guide will help you set up and use the project with Poetry and Makefile.

Prerequisites

Ensure you have the following installed on your machine:

Installation

To install aPhyloGeo, follow these steps:

  1. Clone the repository:

    git clone https://github.com/tahiri-lab/aPhyloGeo.git
  2. Navigate to the repository:

    cd aPhyloGeo
  3. Install dependencies

    a. with Poetry:

    poetry install

    b. with pip:

    pip install -r requirements.txt

Usage

Once you have installed aPhyloGeo, you can use it by following these steps:

  1. Open a terminal and navigate to the project directory.

  2. Activate the Poetry virtual environment:

    poetry shell
  3. Run the application:

    make
  4. Explore the features and functionalities of aPhyloGeo.

Common Tasks

Running Tests

To run tests, use the Makefile:

make test