bindings: Example of using pybind11 with numpy

1 files changed, 28 insertions, 0 deletions

diff --git a/bindings/README.md b/bindings/README.md
new file mode 100644
index 0000000..dee8dfc
--- /dev/null
+++ b/bindings/README.md
@@ -0,0 +1,28 @@
+
+# Python module
+
+## Prerequisites
+
+The following packages are needed.
+Install with pip or via OS package manager.
+
+    pybind11
+    numpy
+    setuptools
+
+
+## Building
+
+To build the module
+
+    python setup.py build_ext --inplace
+
+This will produce a shared library (`.so` on Linux) in PWD, that Python can load.
+
+## Test
+
+To use the module, see the .py file
+
+    python test_galearn_pdm.py
+
+