On Linux the easiest way to get OrthoFinder is to download the latest release package from github as described here: Downloading and running OrthoFinder. This contains everything that’s required in a single package, so you don’t need to install anything.
The best way to use OrthoFinder on Windows is to install the Windows Subsystem for Linux. I’d recommend the Ubuntu installation, which runs OrthoFinder with no problems.
Follow the guide here for installing the Linux Subsystem here: https://docs.microsoft.com/en-us/windows/wsl/install-win10
Once you’ve completed the steps there and confirmed the installation is successful, search for ‘Ubuntu’ in your Start menu to get a bash terminal
Follow the steps in the first tutorial as you would for Linux. I.e. download the ‘OrthoFinder.tar.gz’ package, unpack it and run it: Downloading and running OrthoFinder
You can also run OrthoFinder on Windows using Docker, but running it using this way will be many times slower and so isn’t recommended.
The best way to use OrthoFinder on a Mac is to use Bioconda, see the Bioconda section below for details.
Alternatives include using the source code version and installing the dependencies yourself: python together with the numpy and scipy libraries plus the external programs mcl, diamond & fastme. See https://github.com/davidemms/OrthoFinder#installing-dependencies. There is also a Docker image, but this will run more slowly.
Bioconda provides a very easy way to install OrthoFinder on Linux or Mac. You can refer to the Bioconda Getting Started page for details, but the basic steps are:
curl -L -O https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh sh Miniconda3-latest-MacOSX-x86_64.sh
Or, on Linux:
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh sh Miniconda3-latest-Linux-x86_64.sh
Then for both Linux & Mac:
conda config --add channels defaults conda config --add channels bioconda conda config --add channels conda-forge
Then close your terminal and open a new one to complete the installation. Now install OrthoFinder:
conda install orthofinder
Test you can run OrthoFinder by downloading the Example Dataset to your current working directory from here: https://bioinformatics.plants.ox.ac.uk/davidemms/public_data/ExampleData.zip. Unzip it and then run:
orthofinder -f ExampleData
Thanks to the many people who I’m aware of having contributed to setting this up: Anthony Bretaudeau, Nicola Soranzo, Sacha Laurent, Christian Brueffer, Nathan Weeks, Johannes Köster, pvanheus, Björn Grüning, Emil Hägglund, Andreas Sjödin, Gildas Le Corguillé & Devon Ryan. And thanks also to anyone else who has helped.
You can also just use the standard python version, OrthoFinder_source.tar.gz from the releases page. This will require a python installation (version 2.7 or 3) together with the numpy and scipy libraries. There are detailed instructions here: https://github.com/davidemms/OrthoFinder/#python-source-code-version.
OrthoFinder is available on Docker: davidemms/orthofinder thanks to Thomas Roder & Monjeaud Cyril for their work on this. Running OrthoFinder via Docker is likely to be many times slower than it would be running directly on a linux server or using the Windows Subsystem for Linux, so those approaches are generally recommended instead.
To install Docker, follow the instructions here: https://docs.docker.com/install/
To run OrthoFinder on Windows using Docker:
Open the Windows PowerShell from the Start Menu
mkdir orthofinder cd orthofinder
docker pull davidemms/orthofinder
docker run -it --rm davidemms/orthofinder orthofinder -h
wget https://bioinformatics.plants.ox.ac.uk/davidemms/public_data/ExampleData.zip -outfile ExampleData.zip Expand-Archive -LiteralPath ExampleData.zip -DestinationPath .
You might find it easier to download and extract the files without using the shell, these commands are provided to make it easy to run these steps by copying and pasting if you prefer. The file is here: https://bioinformatics.plants.ox.ac.uk/davidemms/public_data/ExampleData.zip
docker run --ulimit nofile=1000000:1000000 -it --rm -v C:\Users\dops0000\orthofinder\ExampleData\:/input:Z davidemms/orthofinder orthofinder -f /input
On the Docker Desktop icon on the task bar > Settings > Resources you can increase the CPUs and Memory available to applications running in Docker.
OrthoFinder doesn’t need to be installed, you can just call it from where you downloaded it. If you do want to install it somewhere, you will need to include the config.json file in the directory containing orthofinder or in the “source_of” directory if using the source code version.
OrthoFinder help file prints, but it cannot run one of the dependencies:
OrthoFinder/bindirectory and install it yourself. There’s guidance on installing the dependencied here: https://github.com/davidemms/OrthoFinder#installing-dependencies
If the binary package doesn’t work on your computer then:
ImportError: /usr/lib64/libc.so.6: version GLIBC_2.15' not found. Alternatively, you can also use the standard python version, OrthoFinder_source.tar.gz, described above.