summaryrefslogtreecommitdiff
path: root/openEMS/python/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'openEMS/python/README.md')
-rw-r--r--openEMS/python/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/openEMS/python/README.md b/openEMS/python/README.md
new file mode 100644
index 0000000..887e9da
--- /dev/null
+++ b/openEMS/python/README.md
@@ -0,0 +1,14 @@
+# openEMS python interface
+
+## Install
+* Simple version:
+```python
+python setup.py install
+```
+
+* Extended options, e.g. for custom install path at */opt/openEMS*:
+```python
+python setup.py build_ext -I/opt/openEMS/include -L/opt/openEMS/lib -R/opt/openEMS/lib"
+python setup.py install
+```
+**Note:** The install command may require root on Linux, or add --user to install to ~/.local