_images/simplay_logo.png

Animation capabilities for SimPy

PyPI (simplay) | PyPI (simplay-jupyter) | npm (simplay-web) | GitHub | Issues

Overview

SimPlay is a project that aims to bring simple animation capabilities to the SimPy project.

SimPlay is integrated into JupyterLab and is capable of displaying an animation of a SimPy simulation in a notebook:

_images/overview.gif

Check out the Getting started section for further information, including how to Install SimPlay.

The API documentation is available at API Reference.

Structure of the project

SimPlay is split into three parts:

  • The SimPlay package, which is a Python package that can be integrated into SimPy simulations. It is used to generate the animation data and to provide a simple API to do so. It is available on PyPI at https://pypi.python.org/pypi/simplay.

  • The SimPlay-Web package, which is a TypeScript package that is used to display the generated animation data. It is available on npm at https://www.npmjs.com/package/simplay-web.

  • The SimPlay-Jupyter package, which depends on both the packages mentioned above. It is used to display the animation data in Jupyter Lab. It is available on PyPI at https://pypi.python.org/pypi/simplay-jupyter.