init

DOC.md

@@ -0,0 +1,48 @@
+
+# Interactive Point Cloud Study
+
+This project is the implementation of a point cloud study on QoE described in my Bachelor’s thesis.
+
+### Brief Summary of Study Flow:
+- User and task instructions
+- Trial run
+- Study begins
+- End / Feedback / Code issuance 
+
+
+## Documentation
+
+The folder **PCSurvey** contains all the code for the study. The folder **PCStatic** contains images and HTML files for the instruction and information phases of the study.
+
+The files *survey.html* and *survey.js* serve as the entry point and logic for the study. The *survey.js* file constructs the study flow using jsPsych.
+### The "potree" folder
+It contains a folder **pointclouds**, which includes all the point clouds used for the study.
+
+The file *paired_comparison_template.html* creates the interface for this evaluation condition. This interface was developed early on but ultimately was not used. It requires minor adaptations but is overall functional.
+
+The files *sequentiell_template.html* and *sequentiell_template2.html* serve as the interfaces for the sequential evaluation method. We have two versions: one is the first, and the other is the second. It is necessary for them to be separate, even though they are very similar, due to the external HTML loading process in jsPsych.
+
+The files *single_page_template_\*.html* are designated for each element and test condition (1, 2, and 3 elements in the cloud). Each stimulus varies in size and requires special configuration. These files manage those configurations.
+
+All the mentioned files are used in the *survey.js* file to dynamically generate the evaluation block for the study.
+
+
+## Deployment
+The *docker-compose.yml* file provides an example configuration for starting the Docker container with the study. It builds the container using the *Dockerfile* and mounts the volumes for the point cloud folder and the output folder for the captured user data.
+
+Configure mounting and ports based on your case.
+
+```bash
+  docker compose up
+```
+
+After deployment, it can be accessed on:
+
+http://localhost/survey.html?worker=0&campaign=0&randkey=0
+
+The parameters are necessary to pass the requirement test for the study.
+
+## Authors
+
+- Andreas Wilms
+