Download and Installation

BOTMpy can be used as a pure Python package. There are some additional Cython implementations for parts of the code that benefit from it, the Cython part is optional but recommended, BOTMpy will run as a pure Python if desired.

Requirements

For the basic Python version this stack is required:

Please follow the links to the respective websites for instructions on how to install them if they are not present on your computer. For Python, Scipy and Numpy it is advised to use install mechanism appropriate to your operating system, and not use the python packaging mechanism like pip and easy_install.

Download

The easiest way to get BOTMpy is from the Python Package Index (PyPI). If you have pip installed:

$ pip install botmpy

Alternatively, if you have setuptools:

$ easy_install botmpy

Alternatively, you can get the latest version directly from GitHub at https://github.com/pmeier82/BOTMpy.:

$ git clone https://github.com/pmeier82/BOTMpy.git

The master branch (selected by default) always contains the current stable version. All the other branches will be feature branches or integration branches and are not recommended for general usage.

Installation

After you have acquired a copy of the package from GitHub you need to install it on your system by calling:

$ python setup.py install

This is not necessary when you install with either pip or easy_install.

Cython Speedup

To use the Cython implementations you will need a current Cython package (>= 0.15.1) and the sources for Python and Numpy to build the extention modules. The relevant packages for debian are called pythonX.Y-dev and python-numpy-dev.

If the required packages and Cython is present on your system during installation, the cython extensions will be build automatically. There is no change to the interface specific to the cython implementations that the user needs to take care of.