Skip to main content

Windows

May 5 Updates

  • The automated install method with Chocolatey is working.
  • There is also a new version of the Tidal Cycles package in Chocolatey coming soon.
  • The problem with ghc 9.6.1 on Windows was identified by the Haskell team. There is a new version of the network package - network-3.1.2.9. This should also resolve network package errors that come up with the Tidal package install. See details.
  • ghc 9.6.1 and cabal 3.10.1.0 are now the recommended versions for Windows.
  • The steps to install individual components via Chocolatey have been removed. This is not a recommended direction unless you are familiar with choco commands and how choco handles packages installs locally.
  • The Troubleshooting on Windows page has been updated. Use that page for help installing Haskell.

May 11 Updates

  • There is a known issue with the Chocolatey automated install of SuperDirt. Sometimes during the step to install SuperDirt into SuperCollier, the installation hangs after SuperDirt is installed. The cause is likely an orphaned process which can be terminated. See the Troubleshooting on Windows for instructions.
  • Instructions are available to clean up from chocolatey installs. See Windows Chocolatey Cleanup.

Automatic installation - Chocolatey​

note: Installation with Chocolatey works again.

caution

If you have a prior install from chocolatey with an older version of Haskell, you may experience problems running Tidal after a completed new install. This can be caused by multiple versions of Haskell. For example, if you have C:\tools\ghc-8.10.7 and C:\tools\ghc-9.6.1. To fix this, you need to remove the older Haskell version(s) and reinstall the Tidal package. Detailed steps are provided in Windows Chocolatey cleanup.

This method uses the package manager Chocolatey and will install everything you need, including required dependencies. Please note that this is a significant install process and takes time, but in the end all components will be ready for use. The installer assumes that these aren't installed already. If you do have some components (SuperCollider, SuperDirt, etc) it is recommended to use Manual install steps for the remaining components (see below).

Components installed via Chocolatey package manager:

Installation procedure​

Installation has 3 steps. You may get security pop-up windows for you to accept. Windows 7 users: please review the prep steps outlined at the end of this page.

I - Starting powershell as administrator

  • Windows 10 - Hold down the windows key and press 'x', then choose Windows PowerShell (admin) in the menu that pops up.
  • Windows 7 - Click the start button, type powershell, then click with the right mouse button and choose Run as Administrator.

II - Installing Chocolatey: the package manager

The Chocolatey package manager is required. If you haven't installed it previously, you can get it by running this command:

Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))

III - Installing TidalCycles

Run the following command to install Tidal Cycles using Chocolatey:

choco install tidalcycles

Note: The full install will take time (30+ minutes). It is best to let it run to the end, but if it exits without completion or if you need to abort - you can try running this command again. Choco will skip over any package dependencies that are already complete.

After the powershell script is finished, you should review the choco install logs for any errors.
C:\ProgramData\chocolatey\logs\chocolatey.log

IV - Potential problems and fixes

  • SuperCollider quarks install failed for SuperDirt, Dirt Samples, and/or Vowel
    These can be installed manually within the SuperCollider IDE. See the command to execute in the Manual installation section below.

  • Tidal package install failed

    • You can confirm the status of your tidal install with this command: cabal info tidal. If you get a message that "There is no package named tidal" then something went wrong and you need to run these commands.

    • You can attempt the Tidal package install manually. But before installing/reinstalling the Tidal package it is recommended to delete (or rename) your local ghc and cabal directories. These are found in your user \AppData\Roaming directory but could also be in other directories under \AppData\.

      C:\Users\<yourUser>\AppData\Roaming\ghc\
      C:\Users\<yourUser>\AppData\Roaming\cabal\
      C:\Users\<yourUser>\AppData\Local\ghc\
      C:\Users\<yourUser>\AppData\Local\cabal\

    • Now install Tidal:

      cabal update
      cabal v1-install tidal

  • Pulsar install failed

    • Download the installer manually from Pulsar-dev. Once installed, follow the step below to install the TidalCycles plugin package.
    • You can also try to install just Pulsar from choco: choco install pulsar

  • Pulsar install succeeded but didn't install the TidalCycles plugin package
    This can done manually from within Pulsar. From the top menu, open the Package Manager, select Install, then search for TidalCycles, and select install. This will install the TidalCycle package into Pulsar. For more details, see the Pulsar page in the "Get a Text Editor" section.

  • Haskell (ghc) or cabal install fails.
    You can try running the choco install tidalcycles command again. Or you can try installing Haskell components with choco:

choco install ghc
choco install cabal
## use these commands if you know the version numbers
choco install ghc --version=9.6.1
choco install cabal --version=3.10.1.0

  • The installer hangs after SuperDirt completes. You may be able to resolve this by killing an orphaned process. See the Troubleshooting on Windows guide.

  • For other problems, see the Troubleshooting on Windows page.

Manual installation​

This method is recommended for users who already have some of the components installed. Ensure that all components below are installed.

Haskell​

  • Install ghcup (Haskell package installer)
    • See Haskell ghcup for info.
    • See YouTube - windows ghcup install for assistance.
    • Run this command in Windows Powershell (as admin):
      Set-ExecutionPolicy Bypass -Scope Process -Force;[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; try { Invoke-Command -ScriptBlock ([ScriptBlock]::Create((Invoke-WebRequest https://www.haskell.org/ghcup/sh/bootstrap-haskell.ps1 -UseBasicParsing))) -ArgumentList $true } catch { Write-Error $_ }
  • This should install ghci v9.25. But Tidal 1.9.3+ is best with ghc 9.6.1 and cabal 3.10.1.0
  • Run these commands from powershell (admin) to get the correct ghc and cabal versions:
ghcup install ghc 9.6.1
ghcup install cabal 3.10.1.0
ghcup set ghc 9.6.1
ghcup set cabal 3.10.1.0

-- Validate
ghci --version  
cabal --version

SuperCollider​

SC3 Plugins​

SC3 Plugins is needed if you want to use any of the synthesizers included with Tidal Cycles. Most of the examples in the documentation will still work, but your installation will likely be incomplete without it. You can skip the installation but be sure to come back later to install it if you want.

SuperDirt​

SuperDirt is the audio engine used by Tidal. Without it, Tidal Cycles will not emit any sound and will not be able to communicate through OSC or MIDI with other synthesizers. To install it, open SuperCollider and run the following command in the interactive editor (press Ctrl+Return to evaluate):

Quarks.checkForUpdates({Quarks.install("SuperDirt", "v1.7.4"); thisProcess.recompile()})

The installation will take a little while. You will know when the installation process is done by looking at the logs window. It will likely print something like the following:

Installing SuperDirt
Installing Vowel
Vowel installed
Installing Dirt-Samples
Dirt-Samples installed
SuperDirt installed
compiling class library...
...
(then some blah blah, and finally, something like:)
...

*** Welcome to SuperCollider 3.12.1. *** For help press Ctrl-D.

Tidal Cycles​

  • Make sure your Haskell environment is correct (above) and that you have ghci v9.6 1 and cabal 3.10.1.0
  • Open PowerShell in administrator mode (see above).
  • Enter the following commands:
cabal update
cabal v1-install tidal

Make sure to use v1-install, as v2-install tidal may not work. The last command might take some time to complete. Be patient 😄.

Pulsar​

  • See Pulsar-edit Downloads to download and install.
  • OR go to the Pulsar page under Installation > Get a Text Editor section in the left navigation pane.
  • Once you have Pulsar, you need the TidalCycles plugin. Use the Pulsar Package Manager. See details on our Pulsar page.

Getting Help​

If you are having trouble with installation, here are options:

  • Review this page carefully and make sure you are following all instructions.
  • For individual component problems - such as SuperCollider and SuperDirt - check their ReadMe pages in GitHub:
  • TidalCycles Discord - Installation Help Channel
    • Try searching this channel to see if your problem has been experienced by others
    • Be sure to post details - what exact problem, error messages, what Windows version, etc.
    • See the "how to ask" channel for more about getting help from our community
  • Forums - Tidal Club A lot of smart people hang out here.
  • Don't get discouraged! Tidal has a complex stack, but these components are all proven, robust and stable. Once it is all working, it rarely needs to have any attention.

Note for Windows 7 users​

If you are using Windows 7, some extra preparation is required before installing everything else:

  1. Make sure Windows 7 is up to date with the latest patches.
  2. Install/upgrade to .NET 4.5. You can download it here.
  3. Install Visual C++ redistributable. You can download it here

I've installed Tidal Cycles. What's next?​

Look at the sidebar. You will see a list of text editors you can install to interact with Tidal and start playing 😄.

Be sure to follow the instructions to start SuperDirt.