Installation

Installation

Quick install

Run in your terminal:

easy_install -U gensim

or, alternatively:

pip install --upgrade gensim

In case that fails, make sure you’re installing into a writeable location (or use sudo), or read on.

---

Dependencies

Gensim is known to run on Linux, Windows and Mac OS X and should run on any other platform that supports Python 2.6+ and NumPy. Gensim depends on the following software:

• Python >= 2.6. Tested with versions 2.6, 2.7, 3.3, 3.4 and 3.5. Support for Python 2.5 was discontinued starting gensim 0.10.0; if you must use Python 2.5, install gensim 0.9.1.
• NumPy >= 1.3. Tested with version 1.9.0, 1.7.1, 1.7.0, 1.6.2, 1.6.1rc2, 1.5.0rc1, 1.4.0, 1.3.0, 1.3.0rc2.
• SciPy >= 0.7. Tested with version 0.14.0, 0.12.0, 0.11.0, 0.10.1, 0.9.0, 0.8.0, 0.8.0b1, 0.7.1, 0.7.0.

Windows users are well advised to try the Enthought distribution, which conveniently includes Python & NumPy & SciPy in a single bundle, and is free for academic use.

Install Python and easy_install

Check what version of Python you have with:

python --version

You can download Python from http://python.org/download.

Note

Gensim requires Python 2.6 / 3.3 or greater, and will not run under earlier versions.

Next, install the easy_install utility, which will make installing other Python programs easier.

Install SciPy & NumPy

These are quite popular Python packages, so chances are there are pre-built binary distributions available for your platform. You can try installing from source using easy_install:

easy_install numpy
easy_install scipy

If that doesn’t work or if you’d rather install using a binary package, consult http://www.scipy.org/Download.

Install gensim

You can now install (or upgrade) gensim with:

easy_install --upgrade gensim

That’s it! Congratulations, you can proceed to the tutorials.

---

If you also want to run the algorithms over a cluster of computers, in Distributed Computing, you should install with:

easy_install gensim[distributed]

The optional distributed feature installs Pyro (PYthon Remote Objects). If you don’t know what distributed computing means, you can ignore it: gensim will work fine for you anyway. This optional extension can also be installed separately later with:

easy_install Pyro4

---

There are also alternative routes to install:

1. If you have downloaded and unzipped the tar.gz source for gensim (or you’re installing gensim from github), you can run:

   python setup.py install
   

   to install gensim into your site-packages folder.

2. If you wish to make local changes to the gensim code (gensim is, after all, a package which targets research prototyping and modifications), a preferred way may be installing with:

   python setup.py develop
   

   This will only place a symlink into your site-packages directory. The actual files will stay wherever you unpacked them.

3. If you don’t have root priviledges (or just don’t want to put the package into your site-packages), simply unpack the source package somewhere and that’s it! No compilation or installation needed. Just don’t forget to set your PYTHONPATH (or modify sys.path), so that Python can find the unpacked package when importing.

Testing gensim

To test the package, unzip the tar.gz source and run:

python setup.py test

Gensim uses Travis CI for continuous integration:

Problems?

Use the gensim discussion group for questions and troubleshooting. See the support page.