Cutadapt is being developed and tested under Linux. Users have run it successfully under macOS and Windows.
The easiest way to install cutadapt is to use
pip on the command line:
pip install --user --upgrade cutadapt
This will download the software from PyPI (the Python packaging
install the cutadapt binary into
$HOME/.local/bin. If an old version of
cutadapt exists on your system, the
--upgrade parameter is required in order
to install a newer version. You can then run the program like this:
If you want to avoid typing the full path, add the directory
$HOME/.local/bin to your
$PATH environment variable.
Installation with conda¶
conda install -c bioconda cutadapt
If neither pip nor conda installation works, keep reading.
Cutadapt installation requires this software to be installed:
- Python 2.7 or at least Python 3.4
- Possibly a C compiler. For Linux, cutadapt packages are provided as
so-called “wheels” (
.whlfiles) which come pre-compiled.
Under Ubuntu, you may need to install the packages
python3-dev) to get a C compiler.
On Windows, you need Microsoft Visual C++ Compiler for Python 2.7.
If you get an error message:
error: command 'gcc' failed with exit status 1
Then check the entire error message. If it says something about a missing
Python.h file, then the problem are missing Python development
python3-dev in Ubuntu).
System-wide installation (root required)¶
If you have root access, then you can install cutadapt system-wide by running:
sudo pip install cutadapt
This installs cutadapt into /usr/local/bin.
If you want to upgrade from an older version, use this command instead:
sudo pip install --upgrade cutadapt
pip uninstall cutadapt
and confirm with
y to remove the package. Under some circumstances, multiple
versions may be installed at the same time. Repeat the above command until you
get an error message in order to make sure that all versions are removed.
Installing the development version¶
We recommend that you install cutadapt into a so-called virtual environment if you decide to use the development version. The virtual environment is a single directory that contains everything needed to run the software. Nothing else on your system is changed, so you can simply uninstall this particular version of cutadapt by removing the directory with the virtual environment.
The following instructions work on Linux using Python 3. Make sure you have
installed the dependencies (
build-essential on Ubuntu)!
First, choose where you want to place the directory with the virtual
environment and what you want to call it. Let us assume you chose the path
~/cutadapt-venv. Then use these commands for the installation:
python3 -m venv ~/cutadapt-venv ~/cutadapt-venv/bin/pip install Cython ~/cutadapt-venv/bin/pip install https://github.com/marcelm/cutadapt/archive/master.zip
To run cutadapt and see the version number, type
The reported version number will be something like
means that you are now running a cutadapt version that contains 65 additional
changes (commits) since version 1.14.