From 3533f46f0c81b2c8d7d26ef6272cec93aec11558 Mon Sep 17 00:00:00 2001 From: Yentl Van Tendeloo Date: Thu, 6 Apr 2017 08:29:18 +0200 Subject: [PATCH] Updated README with the performance notes --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 278bc1e..1d95169 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,24 @@ cd src python setup.py install --user ``` +Performance +----------- + +For optimal performance results, we recommend the use of [PyPy](http://pypy.org). + +By default, PythonPDEVS is optimized for distributed simulation, therefore doing a lot of additional bookkeeping. +For optimal performance in local simulations, we recommend the use of the *minimal* simulation kernel instead: just update all imports from +```python +from pypdevs.simulator import Simulator +from pypdevs.DEVS import AtomicDEVS, CoupledDEVS +``` +to +```python +from pypdevs.minimal import Simulator +from pypdevs.minimal import AtomicDEVS, CoupledDEVS +``` +Note that this disables many features. + Distributed simulation (optional) ---------------------------------