diff options
author | Rémi Flamary <remi.flamary@gmail.com> | 2019-07-03 14:34:13 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-07-03 14:34:13 +0200 |
commit | 952503e02b1fc9bdf0811b937baacca57e4a98f1 (patch) | |
tree | c5b1b8f10eaee4c2ecaa12f629255489c2481590 /README.md | |
parent | 8b3927bb5e8935c3dbddf054f054dc0c036fbdfe (diff) | |
parent | 7402d344240ce94e33c53daff419d4356278d48f (diff) |
Merge pull request #88 from rflamary/doc_modules
[MRG] Update documentation and add quick start guide
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -54,6 +54,12 @@ The library has been tested on Linux, MacOSX and Windows. It requires a C++ comp #### Pip installation +Note that due to a limitation of pip, `cython` and `numpy` need to be installed +prior to installing POT. This can be done easily with +``` +pip install numpy cython +``` + You can install the toolbox through PyPI with: ``` pip install POT @@ -63,6 +69,8 @@ or get the very latest version by downloading it and then running: python setup.py install --user # for user install (no root) ``` + + #### Anaconda installation with conda-forge If you use the Anaconda python distribution, POT is available in [conda-forge](https://conda-forge.org). To install it and the required dependencies: @@ -151,7 +159,12 @@ You can also see the notebooks with [Jupyter nbviewer](https://nbviewer.jupyter. ## Acknowledgements -The contributors to this library are: +This toolbox has been created and is maintained by + +* [Rémi Flamary](http://remi.flamary.com/) +* [Nicolas Courty](http://people.irisa.fr/Nicolas.Courty/) + +The contributors to this library are * [Rémi Flamary](http://remi.flamary.com/) * [Nicolas Courty](http://people.irisa.fr/Nicolas.Courty/) |