Metadata-Version: 2.0
Name: mot
Version: 0.2.2
Summary: Parallel parameter estimation in python and opencl.
Home-page: https://github.com/robbert-harms/mot
Author: Robbert Harms
Author-email: robbert.harms@maastrichtuniversity.nl
License: LGPL v3
Keywords: mot
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: Development Status :: 5 - Production/Stable
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering
Requires-Dist: grako
Requires-Dist: numpy (>=1.9.0)
Requires-Dist: pyopencl (>=2013.1)

===============================
Maastricht Optimization Toolbox
===============================

.. image:: https://badge.fury.io/py/mot.png
    :target: http://badge.fury.io/py/mot


A library for parallel optimization and sampling in python and opencl.

* Free software: LGPL v3 license
* Full documentation: https://mot.readthedocs.org
* Project home: https://github.com/robbert-harms/MOT
* Uses the `GitLab workflow <https://docs.gitlab.com/ee/workflow/gitlab_flow.html>`_
* Tags: optimization, parallel, opencl, python


Installation
------------
.. highlight:: console

The installation is a three step procedure:

1. Installing a Python interpreter
2. Installing the PyOpenCL drivers and Python bindings
3. Install MOT


|
Installing Python
^^^^^^^^^^^^^^^^^
Since it is a Python package we need to install the Python interpreter. Considering that Python2 is soon end of life, this package focuses on installing it using Python3.

Linux (Ubuntu)
""""""""""""""
``apt-get install python3 python3-pip``


Windows
"""""""
The easiest way is with Anaconda. Install the Python3.x bindings from `Anaconda <https://www.continuum.io/downloads>`_.

|
Installing OpenCL bindings
^^^^^^^^^^^^^^^^^^^^^^^^^^
For OpenCL you need two things, an OpenCL driver for your platform and the Python OpenCL bindings.

Linux (Ubuntu)
""""""""""""""
On Ubuntu, the easiest way to install all of this:

``apt-get install python3-pyopencl``


Windows
"""""""
On Windows, make sure you install the correct OpenCL driver (Intel/AMD/NVidia). For graphics cards the drivers are normally already installed. After that, Anaconda should automatically install the Python bindings.


|
Installing MOT
^^^^^^^^^^^^^^
With OpenCL and Python installed you can now install MOT.

Linux (Ubuntu)
""""""""""""""
``pip3 install MOT``


Windows
"""""""
Open an Anaconda shell and use:

``pip install MOT``


