Merge pull request #218 from pyiron/binder

Add Mybinder example

README.md

@@ -1,6 +1,7 @@
 # pympipool - up-scale python functions for high performance computing
 [![Unittests](https://github.com/pyiron/pympipool/actions/workflows/unittest-openmpi.yml/badge.svg)](https://github.com/pyiron/pympipool/actions/workflows/unittest-openmpi.yml)
 [![Coverage Status](https://coveralls.io/repos/github/pyiron/pympipool/badge.svg?branch=main)](https://coveralls.io/github/pyiron/pympipool?branch=main)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyiron/pympipool/HEAD?labpath=notebooks%2Fexamples.ipynb)
 
 Up-scaling python functions for high performance computing (HPC) can be challenging. While the python standard library
 provides interfaces for multiprocessing and asynchronous task execution, namely

binder/environment.yml

@@ -0,0 +1,11 @@
+channels:
+- conda-forge
+dependencies:
+- python
+- numpy
+- openmpi
+- cloudpickle =3.0.0
+- flux-core
+- mpi4py =3.1.5
+- tqdm =4.66.1
+- pyzmq =25.1.1

binder/kernel.json

@@ -0,0 +1,16 @@
+{
+ "argv": [
+  "flux",
+  "start",
+  "/srv/conda/envs/notebook/bin/python",
+  "-m",
+  "ipykernel_launcher",
+  "-f",
+  "{connection_file}"
+ ],
+ "display_name": "Flux",
+ "language": "python",
+ "metadata": {
+  "debugger": true
+ }
+}

binder/postBuild

@@ -0,0 +1,6 @@
+# jupyter kernel
+mkdir -p /home/jovyan/.local/share/jupyter/kernels/flux
+cp binder/kernel.json /home/jovyan/.local/share/jupyter/kernels/flux
+
+# install pympipool
+pip install .