Merge pull request #7 from alexlib/mybinder_test

Mybinder test
OpenPIV · Apr 13, 2016 · 60a5fd4 · 60a5fd4
2 parents e19989f + b96e620
commit 60a5fd4
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -58,3 +58,18 @@ The OpenPIV documentation is available on the project web page at <http://openpi
 4. David Lasagna  
 5. Mathias Aubert
 
+# Example Binder with requirements.txt
+
+[![Binder](http://mybinder.org/badge.svg)](http://mybinder.org/repo/alexlib/openpiv-python)
+
+A Binder-compatible repo with a `requirements.txt` file.
+
+The `requirements.txt` file should list all Python libraries that your notebooks depend on, and they will be installed using 
+
+```
+pip install -r requirements.txt
+```
+
+Note that many scientific Python libraries (e.g. `numpy`, `scipy`, `sklearn`, etc.) are included already because the [`base`](https://github.com/alexlib/binder/blob/master/images/base/Dockerfile) image for Binder is built on Anaconda.
+
+In this example we include the library `openpiv`, and our notebook shows the tutorial of `openpiv`
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,2 @@
+openpiv
+progressbar