From f108b1e4be661e3017f704e00a6ba425d8ecf702 Mon Sep 17 00:00:00 2001 From: Yentl Van Tendeloo Date: Thu, 1 Dec 2016 09:19:46 +0100 Subject: [PATCH] Added basic information on installation; linked to the main documentation as well --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..278bc1e --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +Installation +============ + +You can easily install PythonPDEVS with the following command. +```sh +cd src +python setup.py install --user +``` + +Distributed simulation (optional) +--------------------------------- + +To use distributed simulation capabilities, run the script *install_mpi4py.sh* to install the necessary MPI library and bindings. + +Documentation +============= + +Detailed documentation of the installation and use of PythonPDEVS can be found in the [PythonPDEVS documentation](https://msdl.uantwerpen.be/documentation/PythonPDEVS).