summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRémi Flamary <remi.flamary@gmail.com>2016-10-31 09:18:43 +0100
committerRémi Flamary <remi.flamary@gmail.com>2016-10-31 09:18:43 +0100
commitafc621c8571a4cdb734b94f7e384fe8dc0cd7823 (patch)
tree2834c0a299139cbb5607988b1ee9c0922b0389a2 /README.md
parentacfea8e233d683e7d505d64c0e5c4fb5d617918a (diff)
uodate readme +dependencies
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 55e9e8a..cd69e68 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,12 @@ The Library has been tested on Linux and MacOSX. It requires a C++ compiler for
- Numpy (>=1.11)
- Scipy (>=0.17)
+- Cython (>=0.23)
+- Matplotlib (>=1.5)
+Under debian based linux the dependencies can be installed with
+```
+sudo apt-get install python-numpy python-scipy python-matplotlib cython
+```
To install the library, you can install it locally (after downloading it) on you machine using
```
@@ -37,7 +43,7 @@ Note that for easier access the module is name ot instead of pot.
## Examples
-The examples folder contain several examples and use case for the library.
+The examples folder contain several examples and use case for the library. The full documentation is available on [Readthedoc](http://pot.readthedocs.io/)
Here is a list of the Python notebook if you want a quick look: