Commit 9ced0fe8 authored by Jan Kiene's avatar Jan Kiene
Browse files

update readme about collection scripts and folder structure

parent 11a55f81
Loading
Loading
Loading
Loading
+11 −3
Original line number Diff line number Diff line
@@ -113,13 +113,14 @@ After the processing is finished, the outputs will be present in the respective
  ```batch
  python collection-scripts\characterization\p800_categorized_samples.py
  python collection-scripts\characterization\p800_preliminaries.py
  python collection-scripts\characterization\bs1534.py
  ```

- For MUSHRA tests, the outputs may be used directly, or in case of multi-input format experiments again need to be manually assembled.
  - These scripts collect items from each experiments `proc_output*` folder(s) and puts the needed files for the listening test into a `proc_final` folder. This folder needs to be uploaded for the dry run and the final delivery of the listening items to the labs.

### Hash generation

The hashes for the `proc_final` (or `proc_output` for BS.1534 experiments) can be generated using the [get_md5.py](other/get_md5.py) script:
The hashes for the `proc_final` can be generated using the [get_md5.py](other/get_md5.py) script:

```shell
> python other/get_md5.py --help
@@ -190,6 +191,13 @@ python other/get_md5.py experiments/characterization/P800-1/proc_final p800-1_ha
    │   ├── <item_name.wav>
    │   ├── <item_name.wav.{0,1,2,3}.csv> for ISM metadata
    │   └── <item_name.wav.met> for MASA metadata
    ├── proc_final
    │   ├── c01
        │   └── <item_name.c01.wav>
    │   ├── c02...
    │   ├── ...c08
    │   └── preliminaries
        │   └── <item_name.c01.wav>
    └── proc_output[_FMT] # for multiple input formats, suffix is present
        ├── c01
        │   └── <item_name.c01.wav>
@@ -200,7 +208,7 @@ python other/get_md5.py experiments/characterization/P800-1/proc_final p800-1_ha
# Quick guide: How to set up a listening test

This section describes step by step how to set up a listening test according to the Processing Plan (IVAS-7) and Test Plan (IVAS-8).
In the following sections the only purpose of the curly brackets is to mark the variables that thave to be replaced with the actual values.
In the following sections the only purpose of the curly brackets is to mark the variables that have to be replaced with the actual values.

## P800