Add the ability to launch examples on Binder

.pre-commit-config.yaml

@@ -15,8 +15,13 @@ repos:
   - id: check-toml
   - id: pretty-format-json
   - id: detect-private-key
-#- repo: local
-#  hooks:
+- repo: local
+  hooks:
+  - id: export_dev_requirements
+    name: Export dev requirements
+    language: system
+    pass_filenames: false
+    entry: peodd -o requirements-dev.txt
 #  - id: export-requirements
 #    name: Export requeriments.txt
 #    language: system

README.md

@@ -1,4 +1,5 @@
-# [![Unit Tests][20]][21] ![Release][31] [![Downloads][70]][71] [![Lines of code][81]](<>) [![Total lines][80]](<>) [![Files][82]](<>) [![License][50]][51]
+# [![Unit Tests][20]][21] ![Release][31] [![Downloads][70]][71] [![Lines of code][81]](<>) [![Total lines][80]](<>) [![Files][82]](<>) [![License][50]][51] [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/easyScience/easyDiffractionLib/develop)
+
 
 <img height="80"><img src="https://raw.githubusercontent.com/easyScience/easyDiffractionApp/master/resources/images/ed_logo.svg" height="65">
 
@@ -56,6 +57,10 @@ Currently **easyDiffractionLib** is in **alpha** and has not been released on **
   ```
 * Select one of the ***.ipynb** files
 
+### Via Binder
+
+Examples can also be run on the online service [binder](https://mybinder.org/). [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/easyScience/easyDiffractionLib/develop) and navigate to the examples folder to run one of the notebooks or create your own.
+
 ## Test
 
 The installation can be verified by running the test suite:

binder/postBuild

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+pip install --extra-index-url https://easyscience.github.io/pypi -r requirements.txt
+pip install -r requirements-dev.txt

examples/Fitting.ipynb

@@ -40,6 +40,12 @@
     "from easyCore import np\n",
     "from easyCore.Fitting.Fitting import Fitter\n",
     "\n",
+    "try:\n",
+    "    from easyDiffractionLib import Phase\n",
+    "except ImportError:\n",
+    "    import sys, os\n",
+    "    sys.path.append(os.path.abspath('..'))\n",
+    "\n",
     "# esyScience, diffraction\n",
     "from easyDiffractionLib import Phases\n",
     "from easyDiffractionLib.sample import Sample as Job\n",
@@ -1072,4 +1078,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 4
-}
+}

examples/Simulation.ipynb

@@ -27,7 +27,12 @@
    "source": [
     "# esyScience, technique-independent\n",
     "from easyCore import np\n",
-    "from easyCore.Fitting.Fitting import Fitter\n",
+    "\n",
+    "try:\n",
+    "    from easyDiffractionLib import Phase\n",
+    "except ImportError:\n",
+    "    import sys, os\n",
+    "    sys.path.append(os.path.abspath('..'))\n",
     "\n",
     "# esyScience, diffraction\n",
     "from easyDiffractionLib import Site, Phase, Phases\n",
@@ -2525,4 +2530,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 5
-}
+}

pyproject.toml

@@ -42,7 +42,6 @@ pytest = "^5.2"
 toml = "^0.10"
 requests = '^2.24'
 hvplot = "^0.7.0"
-jupyter = "^1.0.0"
 ipympl = "^0.8.0"
 matplotlib = "^3.4"
 py3Dmol = "^1.7.0"

requirements-dev.txt

@@ -0,0 +1,7 @@
+pytest>=5.2
+toml>=0.10
+requests>=2.24
+hvplot>=0.7.0
+ipympl>=0.8.0
+matplotlib>=3.4
+py3Dmol>=1.7.0