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).