Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.21 KB

README.md

File metadata and controls

34 lines (24 loc) · 1.21 KB

Genome Tree

Given a list of genomes, will generate a phylogenetic tree.

License

This software is dual-licensed under GPL Version 2 and/or GPL Version 3. You may use this software according to these licenses as is most appropriate for your project on a case-by-case basis. Both licenses can be found in the root directory of the repository.

Prerequisites

Ensure Python and Cargo (Rust) are both installed.

Basic Instructions

Download genomes from GenBank, which should be received as a .zip type. Some genomes may be provided with this repository. Place the .zip files in the genomes_raw directory.

To automatically unzip and preprocess the zip files, run:

python preprocess.py

A new directory called genomes should have been created. We are ready to begin.

To generate the tree, simply run:

cargo run --release

A phylogenetic tree should have been exported as a file to the root directory in a file called 'phylo_tree.txt'. Thank you for using this software.

Things to Note

This software was developed and tested solely on a Linux machine. Python and Rust are both cross-platform, and as such this should work on other systems as well, however I can not guarantee this simply because I have not tested it.