Skip to main content

Alignment trimming software for phylogenetics.

Project description

Logo

Docs · Report Bug · Request Feature


Run ClipKIT in the browser and leave the computing up to us!


ClipKIT is a fast and flexible alignment trimming tool that keeps phylogenetically informative sites and removes others.

If you found clipkit useful, please cite ClipKIT: a multiple sequence alignment trimming software for accurate phylogenomic inference. Steenwyk et al. 2020, PLOS Biology. doi: 10.1371/journal.pbio.3001007.





This documentation covers downloading and installing ClipKIT. Details about each function as well as tutorials for using ClipKIT are available in the online documentation.


Quick Start

# install
pip install clipkit
# run
clipkit input.fa

Installation

If you are having trouble installing ClipKIT, 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 clipkit
pip install clipkit

Note, the virtual environment must be activated to use clipkit.

After using ClipKIT, you may wish to deactivate your virtual environment and can do so using the following command:

# deactivate virtual environment
deactivate

Similarly, 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/ClipKIT.git
cd ClipKIT/
# create virtual environment
python -m venv venv
# activate virtual environment
source venv/bin/activate
# install
make install

To deactivate your virtual environment, use the following command:

# deactivate virtual environment
deactivate

Note, the virtual environment must be activated to use clipkit.


To install via anaconda, execute the following command:

conda install bioconda::clipkit

Visit here for more information: https://anaconda.org/bioconda/clipkit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clipkit-2.4.1.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

clipkit-2.4.1-py2.py3-none-any.whl (20.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file clipkit-2.4.1.tar.gz.

File metadata

  • Download URL: clipkit-2.4.1.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.25.1 setuptools/69.5.1 requests-toolbelt/0.9.1 tqdm/4.66.2 CPython/3.9.6

File hashes

Hashes for clipkit-2.4.1.tar.gz
Algorithm Hash digest
SHA256 8763be0de99762cf4483afbac1e8244c38d41dcb5760fb369ca08e2e5ced1262
MD5 82c5c42124e9087f59dd441da844ef8f
BLAKE2b-256 d130d716599aa7d7f8f954b3f492e2e177223c4cf295189a11bd6476f179e0b9

See more details on using hashes here.

File details

Details for the file clipkit-2.4.1-py2.py3-none-any.whl.

File metadata

  • Download URL: clipkit-2.4.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.25.1 setuptools/69.5.1 requests-toolbelt/0.9.1 tqdm/4.66.2 CPython/3.9.6

File hashes

Hashes for clipkit-2.4.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1fa6ae1193a54d18e7062648b704049af29a42d83b8c70af3d4f0885535e6241
MD5 336a32a77638ecf20cad1179dfef0f09
BLAKE2b-256 946df45bdab575ecae0849e2cad3f7f9dfb1d9bf2847fe046ca76204523325fe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page