installation.rst 2.3 KB

  1. Installation
  2. ============
  3. Installation of the Modelverse is rather simple, as is its simple usage.
  4. We first introduce the dependencies of the Modelverse, followed by installation instructions for the Modelverse itself.
  5. To check whether or not the installation was successful, users can run the enclosed tests.
  6. Dependencies
  7. ------------
  8. The Modelverse reference implementation is relatively dependency-free.
  9. As its code is written in Python 2, a working Python 2.7 interpreter is necessary.
  10. Python 3 should also be supported, although then a Python 3 compatible version of SCCD has to be used as well.
  11. The `SCCD <>`_ module needs to be installed for both the client and server.
  12. Full installation instructions can be found on the project website.
  13. To run the tests, the `pytest <>`_ module must be installed.
  14. Pip
  15. ^^^
  16. To install all dependencies automatically, using Pip, a *requirements.txt* file is provided.
  17. This can be invoked as follows::
  18. pip install -r requirements.txt
  19. PyPy
  20. ^^^^
  21. In case you want to use PyPy, offering increased performance, you need to install both dependencies in PyPy as well.
  22. For SCCD, you can simply install it using PyPy instead of CPython.
  23. For pytest, you also need to install all of pytest's dependencies, and pytest itself.
  24. The easiest way to do this is through *pip*, which you also have to install first for PyPy::
  25. wget
  26. pypy --user
  27. pypy -m pip install pytest --user
  28. Installation
  29. ------------
  30. The Modelverse is merely a set of Python scripts, and there is no real installation, except for its dependencies.
  31. As such, you will only have to download the `Modelverse source code <>`_.
  32. You can now run the scripts in the *scripts/* directory using Python.
  33. In the next section, we go deeper into the relevant scripts.
  34. Tests
  35. -----
  36. To make sure that everything is working correctly, you can execute the tests with the script *scripts/*, executed as follows::
  37. python scripts/
  38. If you prefer to use PyPy, or any other Python interpreter, you can simply replace *python* with the alternative interpreter.
  39. The tests, and all other components of the Modelverse, will make sure that all subsequently spawned instances use the same interpreter.