aboutsummaryrefslogtreecommitdiff
path: root/Python/README
diff options
context:
space:
mode:
Diffstat (limited to 'Python/README')
-rw-r--r--Python/README10
1 files changed, 10 insertions, 0 deletions
diff --git a/Python/README b/Python/README
new file mode 100644
index 000000000..c3a81ef4d
--- /dev/null
+++ b/Python/README
@@ -0,0 +1,10 @@
+The initial python wrapped version. This has the minimal capability of allowing specification of the
+input parameters (i.e. the input file) in python, passing that into BoxLib and then running the time steps.
+
+Building it requires several steps (which will be cleaned up in the future). Go into the new Python directory and run make to build
+libwarpx.so. Then run "python setup.py install", which builds the wrapper and installs it. For this, you will need to have
+swig installed. (In the future, the swig generated wrapper could be put into the repo so swig wouldn't be needed.)
+
+There is a new input file input.py in tests/Langmuir which can run it. You will need to set either DYLD_LIBRARY_PATH (on mac) or
+LD_LIBRARY_PATH (on linux) to the path where the libwarpx.so (i.e. ../../warpx/Python). (This also will be fixed in the future.)
+