MacOS

The installation of Sardine on MacOS is pretty straightforward. You shouldn't encounter any particular issue to make it work properly. I am developing Sardine on MacOS Ventura 13.0.1.

  • [PLEASE READ THE PRE-INSTALLATION PAGE BEFORE GOING FURTHER]

Preparing your environment

The installation of Sardine takes place in several steps and has some prerequisites. You will have to install all the development environment that will allow you to live code comfortably. You will of course have to install Python but also make sure you have SuperCollider, the audio engine used by the application. You will also have to install some tools that will allow you to compile the application.

  1. Install the latest Python version for your OS (currently 3.11).

    • Sardine will not work with a Python older than 3.10.
    • Be careful with distribution provided Python versions! They might be incomplete!
    • Install Pyenv or use virtual environments to keep everything nice and tidy!

  2. Install SuperCollider, the default audio backend used by Sardine.

    • Once this step is over, open SCIDE (or click on the SuperCollider icon) and type: Quarks.install("SuperDirt")
    • Press Shift + Enter and wait for the installation to be done! Close SuperCollider when done.
    • Optional: You can also install sc3plugins to get more audio effects and synthesizers!
    • You might have to add sclang to your path. To do so, copy alias sclang="/Applications/SuperCollider.app/Contents/MacOS/sclang" into your .bashrc or .zshrc in the $HOME directory.

  3. Install NodeJS and Yarn to be able to build the website.

    • NodeJS is a package manager for JavaScript. Yarn is also... a package manager for JavaScript.
    • If you are installing the package from GitHub, the build process for the text editor will start automatically.

Installing Sardine

We will now proceed to the installation of Sardine. Sardine is a Python library which is composed of two modules:

  • Sardine Core: the Python library for live coding. Contains all the goodies.
  • Sardine: an asynchronous Python interpreter AND integrated text editor.

Install the development version (recommanded).

git clone https://github.com/Bubobubobubobubo/sardine
cd sardine && python -m pip install --find-links https://thegamecracks.github.io/python-rtmidi-wheels/ --editable .
  • Optional: You can install the outdated Pypi package but it is older and lagging behind: 
    python -m pip install --find-links https://thegamecracks.github.io/python-rtmidi-wheels/ --editable sardine-system

Note: the --editable flag is optional. You can remove it if you are not planning to modify Sardine!

  • If you get an error when trying to install python-rtmidi because of #include "longintrepr.h", you can try one of the following install commands:
    • python -m pip install git+https://github.com/SpotlightKid/python-rtmidi.git@eb16ab3268b29b94cd2baa6bfc777f5cf5f908ba#egg=python-rtmidi
    • python -m pip install git+https://github.com/SpotlightKid/python-rtmidi.git#eb16ab3268b29b94cd2baa6bfc777f5cf5f908ba

Note: the python-rtmidi project is now undergoing a maintainer transition. The situation should resolve quite soon! :)