Skip to main content
Version: Next

Quick start

Now that you are ready to start, let's use the provided example to get experience with the workflow.

Screencasts​

Windows 11 screencast

Ubuntu 24 screencast

Creating your first campaign​

  • First, download the example folder.
  • Unzip the folder
  • Open the standalone app
  • Click on Campaign > Configure
  • Load the .json located in the example folder
  • You get relocated to the Settings tab
    • Rename the Storage Path if you want
    • Replace the Audio Path value by drag-n-dropping the audio folder located in the example folder
      • You can also type the path manually
      • The outline should turn green if you filled the value correctly
  • Navigate to the Extractions tab if you want to customize extractions
  • Then go to Export tab, and download the new .json file

Generating your first dataset​

Datasets are stored in h5 files and are generated by the Processing CLI tool.

  • Open the Processing CLI tool by double clicking on sse-processing-14.0.0.bat|sh script.
  • Run sse con<path-to-your-campaign.json>
    • Examples
      • Windows: sse C:\path\to\your-campaign.json
      • Ubuntu/macOS: sse /path/to/your-campaign.json
    • You can just start typing sse [space] then drag-n-dropping your config file
  • The config should load into the following menu
  • Select Run all
  • Wait for completion
  • Exit or press Ctrl+C to stop the process

Exploring your first dataset​

  • Open the sound-scape-explorer standalone app
  • In the Audio section, load your .json or .h5 or enter the audio path manually
  • Click on the Start button
  • The Audio service status on the right should turn green, displaying Running, thus unlocking the Explore button
  • Click on Explore
  • The visualization app window opens
  • Load the .h5 dataset in the Open draggable window
  • Select your View
  • The scatter plot should appear
  • Enjoy!