Downloads
Home News Downloads Tutorials User Manual Reference Manual Developer Manual Forums Team Members Future Work FAQ Links Installing Topographica
Topographica is developed under Linux, and is also supported for Windows and Mac OS X. It should work on non-Linux versions of UNIX as well, as long as standard GNU tools like make and GCC are installed.
Whatever platform you use, there are two ways to obtain Topographica. The first, described below and recommended for most users, is to download one of our installation packages for official releases. The second is to use Subversion (SVN), as described on a separate page, for users who want more frequent updates, or who need to modify the source code.
If you want to run large simulations (requiring more than about 3 GB of memory), you should build and run Topographica on a 64-bit platform. No change to the installation procedure is necessary when when using such a platform.
The following sections describe how to obtain Topographica and build it (if necessary) on Windows, OS X, and Linux/UNIX.
Windows
Windows users will generally want to use the self-installing .exe file we provide. Once you have installed it, you can skip straight to the After Installation section below.
Build from source
If instead you want to develop Topographica on Windows, or you want frequent updates, you will probably need to install some additional software on your machine.
We first recommend that you install a more convenient environment for working at the command line than is provided by default. We support building Topographica on Windows via MSYS/MinGW. If your system does not already have MSYS/MinGW, please install MSYS 1.0.11 and MingGW 5.1.4 (from the MinGW download page). Other versions might work, but we have not tested them.
In addition to MSYS, because we do not currently provide a method to compile Python on Windows, it is also necessary to install Python 2.5 if your system does not already have it. An installer package is available from Python.org. Note that currently Python must be installed to
c:\Python25\.Having installed Python, you also need to install some extra packages that we do not yet support building from source:
- Install PIL 1.1.5 if your system does not already have it
- Download and extract tile082.zip; put the
tile0.8.2/directory into yourtopographica/Lib/directory.
Once these requirements are all present, you can follow the common instructions below by using an MSYS terminal (double click on the MSYS icon on your desktop; note that while using an MSYS terminal, you can enter commands as given for Linux/UNIX rather than any alternative that might be given for Windows).
Mac OS X
Although we plan to offer a binary installer for OS X, none is yet available. Fortunately, building Topographica on OS X is straightforward. The instructions here assume you are using OS X 10.5 (Leopard), but should work on any version with minor alterations to provide the required libraries.
Prerequisites
If your system does not already have Apple's Xcode installed, download Xcode 3.0 from the Apple developer web site. Xcode provides the required GCC C/C++ compiler (among other development utilities). Other versions should also work, but have not necessarily been tested.
Now it is necessary to install two third-party support libraries - libpng and freetype - if your system does not already have them. These provide the PNG format handling and the font handling for the matplotlib library used by Topographica, and can be installed however you wish: you can download binaries, or, if you have a package manager such as Fink or MacPorts, you can use it to obtain and install them. We have used Fink successfully:
- Download and install the Fink 0.9.0 Binary Installer package. Again, other versions should work, but have not necessarily been tested.
- Start the Terminal application (usually found in the Utilities folder in the Applications section of Finder) and enter the following command:
fink install libpng3 freetype219.- Optional: If you want to compile a local copy of the documentation (e.g. for online help), use Fink to get imagemagick, transfig, php, and m4 (if these are not already installed):
fink install php5-cli m4 tetex imagemagick transfig. However, this takes about half a day to run (as it needs to compile everything from source), and you first have to set fink to its unstable branch.If you have trouble running
fink, make sure the Fink installation is actually in your path (the default Fink path is/sw/bin/; the installer should have set this up for you). Also, if you prefer not to use the commandline, you can install FinkCommander, a GUI for Fink that allows you to search for the packages above and click to install them.Finally, if you do not already have Tcl/Tk version 8.5 or later installed on your system, you will need to install it to use the Topographica GUI. The easiest method is to install ActiveTcl, although any Framework build of Tcl/Tk 8.5 should work.
Having satisfied these prerequisites, you can follow the instructions for obtaining and building Topographica.
Linux/UNIX
Currently, we do not offer binary installers for Linux, so it is necessary to build Topographica after obtaining it. This is usually straightforward.
Prerequisites
Most Linux systems will already have the required libraries installed, so usually no action will be required here.
On some Linux distributions that start with a minimal set of packages included, such as Ubuntu or the various "live CD" systems, you may need to specify explicitly that some standard libraries be installed in your system, such as
libfreetype,libfreetype-dev,libpng,libpng-dev,libx11-dev,libxft-dev, andzlib, beforemakewill succeed. On some systems the-devpackages are called-devel, and sometimes specific versions must be specified (e.g.libpng12-dev,libfreetype6-dev). Example for Ubuntu 7.0 or 8.04.1:sudo apt-get install libfreetype6 libfreetype6-dev libpng12-0 libpng12-dev libx11-dev libxft-dev zlib1g m4Once these libraries are installed, you can proceed to the common instructions for all platforms.
All platforms
The instructions below assume you have followed any necessary platform-specific instructions described above.
Obtaining Topographica
If you want frequent updates, or you want to modify the source code, please first follow our SVN instructions. Otherwise, download either the
.zipor.tar.gzarchive package from our downloads page, and then unpack it. You will need to do this in a writable directory with approximately 800 megabytes of spaces available (as of 2/2009).Building Topographica
Once you have satisfied the prerequisites for your platform and have downloaded and extracted Topographica, type
make(which may be calledgmakeon some systems) from within thetopographica/directory. It is best to do this as a regular user in the user's own directory, not as a root user with special privileges, because Topographica does not need any special access to your system. The build process will take a while to complete (e.g. about 5-10 minutes on a 1.5GHz Pentium IV machine with a local disk).If all goes well, a script named
topographicawill be created in thetopographica/directory. If you have problems during the build process, try adding-kto themakecommand, which will allow the make process to skip any components that do not build properly on your machine. Topographica is highly modular, and most functionality should be accessible even without some of those components. If you do experience problems during the installation or subsequent use of Topographica on your platform, please check our platform-specific FAQ.If desired, you can also make local copies of the HTML documentation from the web site. To do so, you must have the php, m4, bibtex, convert, and fig2dev commands installed; type
make allinstead of (or after)make. (If you don't have those commands, in most distributions you can get them by installing the php5-cli, m4, tetex, imagemagick, and transfig packages).make allwill also run the regression tests and example files, to ensure that everything is functioning properly on your system. If you do the tests on a machine without a functioning DISPLAY, such as a remote text-only session, there will be some warnings about GUI tests being skipped.After installation
Linux, Mac, and Windows MSYS users can use the
topographicascript to start Topographica. Windows users who installed the .exe can double click on the Topographica icon on the desktop.Running Topographica interactively is described in more detail in the User Manual. If you want to get straight into working with a full network, a good way to begin is by working through the SOM or LISSOM tutorials.
Have fun with Topographica, and be sure to subscribe to the topographica-announce mailing list to hear about future updates!
Hosted by: ![]()
James A. Bednar (jbednar@inf.ed.ac.uk) Last update: Wed Jan 13 21:07:49 EST 2010.