๐ 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:
- Choose
Run All
- Wait for processing completion. When the menu reappears, the processing has finished
- To visualise your data, select
Quit
, then proceed to the ๐๏ธโ๐จ๏ธ Visualisation User Guide
๐ Commandsโ
- Refresh configuration
- Run extractions and aggregations
- Run reductions
- Run computation UMAPs and mean distances matrix
- Purge computation UMAPs and mean distances matrix
- Run autoclusters
- Run trajectories
- Run relative trajectories
- Run digests
- Run all
- Export dataframe
- Export computation UMAPs
- Export mean distances matrix
- Quit
๐งฌ Data inheritanceโ
The graph below details correlated dependencies between each data type.