Added basic information on installation; linked to the main

documentation as well
This commit is contained in:
Yentl Van Tendeloo 2016-12-01 09:19:46 +01:00
parent 8fa7d4aff0
commit f108b1e4be

18
README.md Normal file
View file

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