designspec_directory.html

6 Directory structure

6.1 Introduction

This chapter describes how projects, tests and results are organized in directories.

6.2 AudioJury directory (Administrator)

This is the skeleton directory structure of AudioJury administrator.

AudioJury
+-projects
| +-active
| +-closed
| +-dynamic
+-reports

The directories called "dynamic", "active" and "closed" contain projects which are in that particular state. Subdirectories of these three directories have the structure described in section section 6.5, "Project directory". See section 5.3, "Transitions" for information of what happens when a project goes from one state directory to another.

The "reports" directory is just provided as a convenience. It is a suggested place to put report files.

Scales will be stored in scale.conf file.

The following files are located in the AudioJury directory (Administrator).

Table 2: Files in the AudioJury directory (Administrator)
Filename	Description / Reference
audiojury.conf	9.2. AudioJury Administrator configuration file
scale.conf	9.6. Scale configuration files

6.3 AudioJury directory (Client)

AudioJury
+-projects
+-results

The directory "projects" contains directories of the type described in section 6.5, "Project directory".

The directory "results" is used to store generated results if the client program was not able to write them to the shared folder. See section 2.3, "Result collection".

The following files are located in the AudioJury directory (Client):


Filename	Description / Reference
audiojury.conf	9.3. AudioJuryClient configuration file

Table 3: Files in the AudioJury directory (Client)

6.4 Shared folder directory

The "shared folder" directory contains a number of directories of the type described in section 6.5, "Project directory".

Example structure of a shared folder containing N number of projects:

[SharedFolder]
+-results
+-[ProjectName1]
+-[ProjectName2]
+-[ProjectName3]
...
+-[ProjectNameN]

The directory named "results" contains result files that have been received from all the client programs and have not yet been fetched by the administrator program. See section 2.3, "Result collection".

6.5 Project directory

The name of the project directory defines the name of the project inside it. Each test in the project is contained in a subdirectory of the project directory and has the structure described in section section 6.6, "Test directory".

The subdirectory called "results" will be filled with received result files when the project is in active state. Note that this is only true if the project directory is a subdirectory of AudioJury directory (Administrator) described in section 6.2.

Example structure of a project directory containing N number of tests:

[ProjectName]
+-results
+-[TestName1]
+-[TestName2]
+-[TestName3]
...
+-[TestNameN]


Filename	Description / Reference
project.conf	9.4. Project configuration file

Table 4: Files in the Project directory

6.6 Test directory

The name of the test directory defines the name of the test inside it. Each audio file that is part of the test is located in that directory.


Filename	Description / Reference
test.conf	9.5. Test configuration file
*.wav	The audio files that make up the test.

Table 5: Files in the Test directory