Commit faf85532 authored by Steven Cordwell's avatar Steven Cordwell

[doc] Update README

Update the readme to point to Travis CI logo, and also to the GitHub and
PyPI locations for getting the package rather than Google Code.
parent 4eb04aa1
Markov Decision Process (MDP) Toolbox 4.0 for Python
====================================================
.. image:: https://travis-ci.org/sawcordwell/pymdptoolbox.svg?branch=master
:target: https://travis-ci.org/sawcordwell/pymdptoolbox
The MDP toolbox provides classes and functions for the resolution of
descrete-time Markov Decision Processes. The list of algorithms that have been
implemented includes backwards induction, linear programming, policy iteration,
q-learning and value iteration along with several variations.
The classes and functions were developped based on the
`MATLAB <http://www.mathworks.com/products/matlab/>`_
`MATLAB <http://www.mathworks.com/products/matlab/>`_ py:
`MDP toolbox http://www.inra.fr/mia/T/MDPtoolbox/>`_ by the
`Biometry and Artificial Intelligence Unit <http://mia.toulouse.inra.fr/>`_ of
`INRA Toulouse <http://www.toulouse.inra.fr/>`_ (France). There are editions
......@@ -25,25 +28,30 @@ Features
Documentation
-------------
Documentation is available as docstrings in the module code and as html in the
doc folder or from `the MDPtoolbox homepage <http://www.>`_.
doc folder or from `the MDPtoolbox homepage <http://www.TODO>`_.
Installation
------------
1. Download the latest stable release from
`http://code.google.com/p/pymdptoolbox/downloads/list`_ or clone the
1. Download the latest stable release from
`https://pypi.python.org/pypi/pymdptoolbox`_ or clone the
Git repository
``git clone https://code.google.com/p/pymdptoolbox/``
``git https://github.com/sawcordwell/pymdptoolbox.git``
2. If you downloaded the `*.zip` or `*.tar.gz` archive, then extract it
``tar -xzvf pymdptoolbox-<VERSION>.tar.gz``
``unzip pymdptoolbox-<VERSION>``
3. Change to the PyMDPtoolbox directory
3. Change to the PyMDPtoolbox directory
``cd pymdptoolbox``
4. Install via Distutils, either to the filesystem or to a home directory
4. Install via Setuptools, either to the filesystem or to a home directory
``python setup.py install``
``python setup.py install --home=<dir>``
``python setup.py install --user``
Alternatively if you have `pip <https://pip.pypa.io/en/latest/>`_
available then just type ``pip install pymdptoolbox`` at the console. If you
also want to be able to solve MDPs using linear programming from the cvxopt
package then type ``pip install "pymdptoolbox[LP]"``.
Quick Use
---------
......@@ -60,8 +68,9 @@ solve it using the value iteration algorithm, and then check the optimal policy.
Contribute
----------
Issue Tracker: https://code.google.com/p/pymdptoolbox/issues/list
Source Code: https://code.google.com/p/pymdptoolbox/source/checkout
Issue Tracker: https://github.com/sawcordwell/pymdptoolbox/issues
Source Code: https://github.com/sawcordwell/pymdptoolbox
Support
-------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment