Docs · Report Bug · Request Feature
PhyKIT is a UNIX shell toolkit for processing and analyzing phylogenomic data.
If you found PhyKIT useful, please cite PhyKIT: a broadly applicable UNIX shell toolkit for processing and analyzing phylogenomic data. Bioinformatics. doi: 10.1093/bioinformatics/btab096.
This documentation covers downloading and installing PhyKIT. Details about each function as well as tutorials for using PhyKIT are available in the online documentation.
Quick Start
# install
pip install phykit
# run
phykit <function> <input file>Installation
If you are having trouble installing PhyKIT, please contact the lead developer, Jacob L. Steenwyk, via email or twitter to get help.
To install using pip, we strongly recommend building a virtual environment to avoid software dependency issues. To do so, execute the following commands:
# create virtual environment
python -m venv .venv
# activate virtual environment
source .venv/bin/activate
# install phykit
pip install phykitNote, the virtual environment must be activated to use phykit.
After using PhyKIT, you may wish to deactivate your virtual environment and can do so using the following command:
# deactivate virtual environment
deactivateSimilarly, to install from source, we strongly recommend using a virtual environment. To do so, use the following commands:
# download
git clone https://github.com/JLSteenwyk/PhyKIT.git
cd PhyKIT/
# create virtual environment
python -m venv .venv
# activate virtual environment
source .venv/bin/activate
# install
make installTo deactivate your virtual environment, use the following command:
# deactivate virtual environment
deactivateNote, the virtual environment must be activated to use phykit.
To install via anaconda, execute the following command:
conda install bioconda::phykitVisit here for more information: https://anaconda.org/bioconda/phykit
To test phykit installation, launch the help message
phykit -h