Skip to main content
Version: 12.0.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.

👋 Welcome to SoundScapeExplorer v12.0.0!

┏━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ File    ┃ Path                                      ┃
┡━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ config  │ relative/or/absolute/path/to/config.xlsx  │
│ storage │ relative/or/absolute/path/to/storage.h5   │
└─────────┴───────────────────────────────────────────┘
? Choose your action  (Use arrow keys)
 ❯ Refresh configuration
   Run extractions and aggregations
   Run reductions
   ---------------
   Run computation UMAPs and mean distances matrix (needed for autocluster)
   Purge computation UMAPs and mean distances matrix
   ---------------
   Run autoclusters
   Run trajectories
   Run relative trajectories
   Run digests
   ---------------
   Run all
   ---------------
   Export dataframe as .csv
   Export computation UMAPs as .npy
   Export mean distances matrix as .npy
   Repack storage with `h5repack` (UNIX only)
   ---------------
   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​