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