updated docs

README.MD

@@ -7,9 +7,11 @@ The main steps are:
 2. Convert CSV Surveys to LAS using EPSG:4978
 3. Group and Crop by H3 Cells
 
-# How to run
+`./PotreeConverter` converts LAS files into Potree's Octree Structure, which the Molloy Explorer Potree Viewer supports as its native input format.
 
-## 1. Prepare Files and Folders
+## How to run
+
+### 1. Prepare Files and Folders
 
 Before running the script, make sure your project folder has the following structure:
 
@@ -27,48 +29,52 @@ metadata/
     └── level1_h3_cells.csv
 ```
 
-### `surveys/`
+#### `surveys/`
+
 - Contains **one folder per survey**, using the **survey name** as the folder name.
 - Each survey folder contains the CSV files for that survey (arbitrarily named).
 
-### `metadata/metadata.csv`
+#### `metadata/metadata.csv`
+
 - Must include the columns: `fid`, `survey_name`, `survey_area`, `geom`, `epsg`.
 - Script assumes bounding polygons in `geom` use EPSG:4258.
 - Each row corresponds to a survey.
 
-### `metadata/level1_h3_cells.csv`
-- Must contain a single column `cell_id`, listing all relevant **level 1 H3 cells**.
+#### `metadata/level1_h3_cells.csv`
 
+- Must contain a single column `cell_id`, listing all relevant **level 1 H3 cells**.
 
-## 2. Activate python environment
+### 2. Activate python environment
 
 Create a python virtual environment with
+
 ```zsh
 python -m venv <environment_name>
 ```
 
 Activate it:
 
-* **Windows:**
+- **Windows:**
+
 ```zsh
 <environment_name>\Scripts\activate
 ```
 
-* **macOS/Linux:** 
+- **macOS/Linux:**
+
 ```zsh
 source <environment_name>/bin/activate
 ```
 
-## 3. Install requirements
+### 3. Install requirements
 
 Install the required Python packages:
 
 ```zsh
 pip install -r requirements.txt
 ```
 
-
-## 4. Run the script
+### 4. Run the lasConverter script
 
 Run the converter:
 
@@ -77,3 +83,34 @@ python lasConverter.py
 ```
 
 The processed LAS files, cropped to level 2 H3 cells, will be saved in the `./h3_cells` folder.
+
+#### Setup PotreeConvert
+
+First make a build directory in the Potree directory
+
+```zsh
+cd PotreeConverter
+mkdir build
+cd build
+```
+
+Then run
+
+```zsh
+cmake ../
+make
+```
+
+### 6. Run the PotreeConverter
+
+From the root of the repository, run the run.sh script to convert the H3 cells into the Potree Structure.
+
+```zsh
+./run.sh
+```
+
+The output is saved in `./pointclouds`. It can then be directly moved into the Viewer or the shell script can be adjusted to automatically save the files in the Viewer.
+
+### 7. Optimizations
+
+This script runs the PotreeConverter on each of the H3 cells sequentially. It is possible to modify the shell script to run these conversions in parallell.