Skip to main content
Version: 13.7.0

๐Ÿ“– User Guide

Upon module initiation, the configuration will load, and a storage file will either be created or opened. Subsequently, the ๐Ÿ“‘ Menu will be displayed.

Most users typically opt for the Run All option to execute all metrics specified in the configuration.

๐Ÿ“‘ Menuโ€‹

Upon module initiation, the following menu will appear:

tip

Use the arrow keys or j/k to navigate through the menu.

Press Enter to run the selected choice.

Loading configuration...
Config loaded: /app/examples/campaigns/coral-reef-light/coral-reef-light.xlsx
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ Setting โ”ƒ Value โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ storage_path โ”‚ /app/examples/campaigns/coral-reef-light/coral-reef-light.โ€ฆ โ”‚
โ”‚ audio_path โ”‚ /app/examples/campaigns/coral-reef-light/audio โ”‚
โ”‚ expected_sample_rate โ”‚ 44100 โ”‚
โ”‚ timeline_origin โ”‚ 2021-01-01 00:00:00 โ”‚
โ”‚ audio_host โ”‚ โ”‚
โ”‚ timezone โ”‚ None โ”‚
โ”‚ computation_umap_dimensions โ”‚ 3 โ”‚
โ”‚ computation_umap_iterations โ”‚ 10 โ”‚
โ”‚ display_umap_seed โ”‚ 42000 โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
๐Ÿ‘‹ Welcome to SoundScapeExplorer v13.7.0!

State in storage:
โŒ Missing
โœ… Present

? Choose your action
โฏ Run all
---------------
โŒ Refresh configuration
โŒ Run extractions and aggregations
โŒ Run reductions
---------------
โŒ Run computation UMAPs and mean distances matrix (needed for autocluster and relative trajectories)
Purge computation UMAPs and mean distances matrix
---------------
โŒ Run autoclusters
โŒ Run trajectories
โŒ Run relative trajectories
โŒ Run digests
---------------
Export dataframe as .csv
Export computation UMAPs as .npy
Export mean distances matrix as .npy
---------------
Quit

๐Ÿ“‹ Most Common Use Caseโ€‹

For executing all metrics specified in your configuration file:

  1. Choose Run All
  2. Wait for processing completion. When the menu reappears, the processing has finished
  3. To visualise your data, select Quit, then proceed to the ๐Ÿ‘๏ธโ€๐Ÿ—จ๏ธ Visualisation User Guide

๐Ÿ‘‰ Commandsโ€‹

๐Ÿงฌ Data inheritanceโ€‹

The graph below details correlated dependencies between each data type.