Skip to content

Commit

Permalink
fixed readme typos & added link to potreeconverter docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiaobr committed Nov 8, 2025
1 parent 6412703 commit b6526ce
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,18 @@ The main steps are:
2. Convert CSV Surveys to LAS using EPSG:4978
3. Group and Crop by H3 Cells

`./PotreeConverter` converts LAS files into Potree's Octree Structure, which the Molloy Explorer Potree Viewer supports as its native input format.
`./PotreeConverter` converts LAS files into Potree's Octree Structure, which the Molloy Explorer Potree Viewer supports as its native input format. Additional documentation on the PotreeConverter can be found in the PotreeConverter GitHub repository: [PotreeConverter](https://github.com/potree/PotreeConverter)

## How to run
## Requirements

### Prerequisites

- CMAKE Version >= 3.16
- PDAL

### 1. Prepare Files and Folders
You will need to have CMAKE version 3.16 or later to run the PotreeConvert to create the data structure.

### Prepare Files and Folders

Before running the script, make sure your project folder has the following structure:

Expand Down Expand Up @@ -44,7 +51,9 @@ metadata/

- Must contain a single column `cell_id`, listing all relevant **level 1 H3 cells**.

### 2. Activate python environment
## How to run

### 1. Activate python environment

Create a python virtual environment with

Expand All @@ -66,15 +75,15 @@ Activate it:
source <environment_name>/bin/activate
```

### 3. Install requirements
### 2. Install requirements

Install the required Python packages:

```zsh
pip install -r requirements.txt
```

### 4. Run the lasConverter script
### 3. Run the lasConverter script

Run the converter:

Expand All @@ -84,7 +93,7 @@ python lasConverter.py

The processed LAS files, cropped to level 2 H3 cells, will be saved in the `./h3_cells` folder.

### 5. Setup PotreeConverter
### 4. Setup PotreeConverter

First make a build directory in the Potree directory

Expand All @@ -101,7 +110,7 @@ cmake ../
make
```

### 6. Run the PotreeConverter
### 5. Run the PotreeConverter

From the root of the repository, run the run.sh script to convert the H3 cells into the Potree Structure.

Expand All @@ -111,6 +120,6 @@ From the root of the repository, run the run.sh script to convert the H3 cells i

The output is saved in `./pointclouds`. It can then be directly moved into the `public` folder in the Molloy Explorer viewer or the shell script can be adjusted to automatically save the files in the viewer.

### 7. Optimizations
### 6. 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.

0 comments on commit b6526ce

Please sign in to comment.