Skip to content

Installation for development

  1. Install Poetry, e.g., with pip install poetry (pip3 install poetry) command (other possible ways of installation see here)
  2. Download and unpack or clone the repository.
  3. Run the command poetry install or poetry install -E examples (the later command installs optional dependencies needed to run some examples). This command will create .venv directory with a virtual environment and install dependencies into it.
  4. Run any example with poetry run python examples/sparks.py (insert a file name of an example).
  5. Or activate the virtual environment with poetry shell and run an example with python examples/sparks.py command. You can also open the directory with the project in some IDE (e.g., PyCharm or VS Code) and select Python interpreter from the virtual environment as a project interpreter, then run examples directly from the IDE.