Installing PyIBL

PyIBL requires Python version 3.2 or later. If you do not have other constraints on what version(s) of Python you use, version 3.4 or later is recommended. Recent versions of Mac OS X and recent Linux distributions likely have a suitable version of Python installed, but it will probably need to be invoked as python3 instead of just python, which typically runs a 2.x version. Python, for Windows, Mac OS X, Linux, or other Unices, can be downloaded from python.org, for free. On Windows python is often invoked as py rather than python.

Note that PyIBL is simply a Python module, a library, that is run as part of a larger Python program. To build and run models using PyIBL you do need to do some Python programming. If you’re new to Python, a good place to start learning it is The Python Tutorial. To write and run a Python program you need to create and edit Python source files, and then run them. If you are comfortable using the command line, you can simply create and edit the files in your favorite text editor, and run them from the command line. Many folks, though, are happier using a graphical Integrated Development Environment (IDE). Many Python IDEs are available. One is IDLE, which comes packaged with Python itself, so once you’ve installed Python you should have it available.

PyIBL can be downloaded, for research use, from http://downloads.ddmlab.com/pyibl. You will be asked to register with the DDMLab before downloading PyIBL. Then download the PyIBL source distribution, pyibl-2.0.1.zip. Also available for download from the same page is a PDF version of this documentation, pyibl-2.0.1-documentation.pdf. After you have downloaded the source distribution, installing PyIBL should be as simple as running, in the directory into which you have downloaded it,

python -m pip install pyibl-2.0.1.zip

Unfortunately there is great variability in what version, or versions, of Python are installed on any given machine; what version, or versions, of distribution software they use and/or have been installed; and a plethora of other complications. Depending upon your situation you may have to

Whatever recipe you normally use to install other Python packages on your machine should work for PyIBL.

If you do not have pip available or do not want to use it you can simply unpack and install the source distribution by hand. After unpacking it with an appropriate tool (e.g. unzip) run, in the directory that has been created by unpacking the file:

python3 setup.py install