Installation

Installing from pre-built binaries

Polypolish compiles to a single executable binary (called polypolish), which makes installation easy!

Each release of Polypolish contains a pre-built binary for common operating systems (e.g. macOS, Ubuntu and CentOS). If you use one of these OSs, you can download the appropriate binary for your system and put the polypolish file in a directory that's in your PATH variable, e.g. /usr/local/bin/ or ~/.local/bin/.

Alternatively, you don't need to install Polypolish at all. Instead, you can just run it from wherever the polypolish executable happens to be, like this: /some/path/to/polypolish --help.

Installing from source

There are a number of reasons why the pre-built binaries may not be ideal:

• you're using incompatible hardware or an unusual OS
• you want a version of Polypolish that doesn't correspond to a release (e.g. the latest commit)
• you want to modify the source code

If any of these apply to you, then you'll have to build Polypolish from source. Install Rust if you don't already have it. Then clone and build Polypolish like this:

git clone https://github.com/rrwick/Polypolish.git
cd Polypolish
cargo build --release

You'll find the freshly built executable in target/release/polypolish, which you can then move to an appropriate location that's in your PATH variable.

Other installation methods

Polypolish is also on Bioconda and Docker Hub. However, these were set up by other developers and I haven't used them, so I can't personally vouch for those methods.