- Painless installation with Homebrew
- Installation (with varying levels of pain)
- Running the “Mini Test”
The latest version of anvi’o is
v2.2.2. See the release notes.
This article explains basic steps of installing anvi’o using rather conventional methods.
Please post a comment down below if you have any questions about the installation. You may want to consider opening an issue for more technical problems.
A note on Chrome
Currently, the Chrome Web Browser has the most efficient SVG engine among all browsers we tested. For instance, Safari can run the anvi’o interactive interface, however it takes orders of magnitude more time and memory compared to Chrome. Firefox, on the other hand, doesn’t even bother drawing anything at all. Long story short, the anvi’o interactive interface will not perform optimally with anything but Chrome. So you need Chrome. Moreover, if Chrome is not your default browser, every time interactive interface pops up, you will need to copy-paste the address bar into a Chrome window. You can learn what is your default browser by running this command in your terminal:
python -c 'import webbrowser as w; w.open_new("http://")'
Painless installation with Homebrew
If you are using Mac and have Homebrew installed on your computer, all you need to do is to run this to have anvi’o installed on your system, and skip the rest of this page (although we suggest you to run
brew doctor in your terminal first to make sure everything is good to go):
brew install homebrew/science/anvio
If you are installing anvi’o on another operating system (or if you an OS X user who does not like Homebrew for some reason) please continue reading.
Installation (with varying levels of pain)
First things first. You need to make sure your system does have all the following software if you are going to follow any of the following installation instructions. It is not as scary as it looks. If you just follow these links, you will most probably be golden:
Finally you will need
virtualenv. This should work for most:
pip install virtualenv
Please note, since the version
2.2.0, anvi’o uses Python 3.
If you don’t have
pip, you will need to visit this web page to get it installed.
If you run into any trouble, send an e-mail to Google Groups for anvi’o.
OK. If you are still here, you may have gone through the most painful part already. Anvi’o developers are very proud of you.
Installing the latest stable release (safe mode)
This is the best way to install the stable release. You will do everything in a Python virtual environment. If you are not experienced with computer stuff, do not worry. If you have taken care of your dependencies mentioned above, the rest is very simple.
We first need to create a new virtual environment for anvi’o. Since it is easier to keep all virtual environments in one place, I will first create a directory in my home:
Then create a new virtual environment for anvi’o under that directory, to activate it, and to check the Python version in it:
virtualenv ~/virtual-envs/anvio-2.2.2 source ~/virtual-envs/anvio-2.2.2/bin/activate python --version
The output of the last command must start with
Python 3. If not, remove the virtual environment with
rm -rf ~/virtual-envs/anvio, and find out how can you create a virtual environment for Python 3 on your system. You can try
-p python3 as a parameter to your
virtualenv command. Or you can type
virtualenv and without pressing the space character press
TAB key twice quickly to see if there is an alternative binary such as
virtualenv-3.5. If not, it means Python 3 is not installed on your system.
Make sure your paths look alright. Yours should look similar to this:
(anvio-2.2.2) meren ~ $ which pip /Users/meren/virtual-envs/anvio-2.2.2/bin/pip
Now you can do the installation:
pip install numpy pip install scipy pip install cython pip install anvio
If all looks good, now you should be able to run
anvi-self-test --suite mini
If this runs successfully, a browser window will popup. Don’t forget to go back to your terminal and press
CTRL+C to kill the server. To leave the virtual environment, you can run the command
Now every time you want to use anvi’o, you will need to activate the virtual environment. If you like things to be convenient as much as we do, you may want to run the following command so you have a new command,
anvi-activate that activates your anvi’o installation:
echo 'alias anvi-activate-v2.2.2="source ~/virtual-envs/anvio-2.2.2/bin/activate"' >> ~/.bash_profile
When I open a new terminal, things look like this:
meren ~ $ anvi-interactive -v -bash: anvi-interactive: command not found meren ~ $ anvi-activate-v2.2.2 (anvio) meren ~ $ anvi-interactive -v Anvi'o version ...............................: 2.2.2 Profile DB version ...........................: 20 Contigs DB version ...........................: 8 Pan DB version ...............................: 5 Samples information DB version ...............: 2 Genome data storage version ..................: 1 Auxiliary data storage version ...............: 3 Anvi'server users data storage version .......: 1 (anvio) meren ~ $
If you get an error from
cherrypy when the interactive interface is run, or you see a “This site can’t be reached / 0.0.0.0 refused to connect” error in your Chrome browser, please see this e-mail to fix it.
Installing or updating from the active codebase (because why not)
This will allow you to go beyond the stable version and follow the very current version of the codebase (we assume you already have taken of your dependencies).
Let’s setup a new virtual environment and activate it:
virtualenv ~/virtual-envs/anvio-dev source ~/virtual-envs/anvio-dev/bin/activate python --version
Don’t forget to make sure the output of the last command starts with
I need to get the codebase
So this is your first time with the codebase. Get a fresh copy (with all the submodules necessary):
cd git clone --recursive https://github.com/meren/anvio.git
Then go into the
anvio directory, and then run the installation:
cd anvio source ~/virtual-envs/anvio-dev/bin/activate pip install -r requirements.txt python setup.py install
I already have the codebase
So you want to update your already existing installation. Follow these steps:
Now it is time to run
anvi-self-test --suite mini, of course.
If you want to make things simpler, you can add an alias to your
~/.bash_profile to easily switch to this environment:
echo 'alias anvi-activate-dev="source ~/virtual-envs/anvio-dev/bin/activate"' >> ~/.bash_profile
Installation for developers (you’re a wizard, arry)
If you are planning to do this, you really need no introductions, but I will give you one anyway. Clone the codebase into a
$DIR you like:
Create a virtual environment (
master to remind you that you are following the GitHub
master), and do the initial setup, and leave it:
virtualenv ~/virtual-envs/anvio-master source ~/virtual-envs/anvio-master/bin/activate python --version # make sure the output starts with `Python 3`. cd $DIR/anvio # don't forget to update the $DIR with the real path pip install -r requirements.txt python setup.py build cp build/lib.*/anvio/*so anvio/ rm -rf anvio.egg-info build dist deactivate
Then update your activation batch to add necessary environment variables (keep in mind that you need to update the
$DIR variable with whatever it shows in your system):
echo 'export PYTHONPATH=$PYTHONPATH:$DIR/anvio/' >> ~/virtual-envs/anvio-master/bin/activate echo 'export PATH=$PATH:$DIR/anvio/bin:$DIR/anvio/sandbox' >> ~/virtual-envs/anvio-master/bin/activate
That’s it. If you like, add an alias to your
~/.bash_profile to activate this quickly:
echo 'alias anvi-activate-master="source ~/virtual-envs/anvio-master/bin/activate"' >> ~/.bash_profile source ~/.bash_profile
Finally, if you would like to pull the latest commits from GitHub every time you switch to the
master, add these to your activation batch (you will need to update
$DIR once again):
echo 'cd $DIR && git pull && cd -' >> ~/virtual-envs/anvio-master/bin/activate
You are golden.
Running the “Mini Test”
You can make anvi’o test itself by running the program
Upon the successful completion of all the tests, your browser should popup to take you to the interactive interface. When you click that ‘Draw’ button, you should see something like this (this is one of the older version of the anvi’o interactive interface, and it shall stay here so we remember where we came from):
All fine? Perfect! Now you have a running installation of anvi’o!