summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRémi Flamary <remi.flamary@gmail.com>2018-06-11 12:01:27 +0200
committerRémi Flamary <remi.flamary@gmail.com>2018-06-11 12:01:27 +0200
commitef17fcd2d5e85b986ff21d8039483bdaf03e37da (patch)
tree25cf5915a26273b3e0726494ed4a1405ce1e2786 /README.md
parent8046b8c424d7b80f520e212e2bf8de41cb624aab (diff)
parent530dc93a60e9b81fb8d1b44680deea77dacf660b (diff)
Merge branch 'master' into smooth_ot
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.md b/README.md
index 6d3286b..68c64c1 100644
--- a/README.md
+++ b/README.md
@@ -26,12 +26,23 @@ It provides the following solvers:
Some demonstrations (both in Python and Jupyter Notebook format) are available in the examples folder.
+#### Using and citing the toolbox
+
+If you use this toolbox in your research and find it useful, please cite POT using the following bibtex reference:
+```
+@article{flamary2017pot,
+ title={POT Python Optimal Transport library},
+ author={Flamary, R{\'e}mi and Courty, Nicolas},
+ year={2017}
+}
+```
+
## Installation
The library has been tested on Linux, MacOSX and Windows. It requires a C++ compiler for using the EMD solver and relies on the following Python modules:
- Numpy (>=1.11)
-- Scipy (>=0.17)
+- Scipy (>=1.0)
- Cython (>=0.23)
- Matplotlib (>=1.5)
@@ -157,16 +168,7 @@ This toolbox benefit a lot from open source research and we would like to thank
* [Nicolas Bonneel](http://liris.cnrs.fr/~nbonneel/) ( C++ code for EMD)
* [Marco Cuturi](http://marcocuturi.net/) (Sinkhorn Knopp in Matlab/Cuda)
-## Using and citing the toolbox
-If you use this toolbox in your research and find it useful, please cite POT using the following bibtex reference:
-```
-@article{flamary2017pot,
- title={POT Python Optimal Transport library},
- author={Flamary, R{\'e}mi and Courty, Nicolas},
- year={2017}
-}
-```
## Contributions and code of conduct
Every contribution is welcome and should respect the [contribution guidelines](CONTRIBUTING.md). Each member of the project is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).