Examples overview¶

Info

All examples are located under the examples/ subdirectory inside the repository.

Important

Some examples require additional third-party packages. Install them with:

From PyPI From source

josephine@laptop:~$ pip install supriya[examples]

josephine@laptop:~$ git clone https://github.com/supriya-project/supriya.git
josephine@laptop:~$ cd supriya
josephine@laptop:~/supriya$ pip install -e .[examples]

Unless specified otherwise in the example’s README.md (or in the example’s documentation here) you can run the example like a script:

josephine@laptop:~/supriya$ python -m examples.hello_world

Examples can be explored in any order, but - in general - they progress from simple subjects to more complex ones in the order they appear in the documentation here.