Key Features • Installation • Quick Start • Documentation • Contribute • Licence • Reference
Bulldozer is designed as a pipeline of standalone functions that aims to extract a Digital Terrain Model (DTM) from a Digital Surface Model (DSM).
But you can also use one of the following function without running the full pipeline:
For more information about these functions and how to call them, please refer to the notebook documentation section.
You can install Bulldozer by running the following command:
pip install bulldozer-dtm
It is recommended to install Bulldozer into a virtual environment, like conda or virtualenv.
virtualenv
:# Clone the project
git clone https://github.com/CNES/bulldozer.git
cd bulldozer/
# Create the environment
python -m venv bulldozer_venv
source bulldozer_venv/bin/activate
# Install the library
pip install .
First you have to create a configuration file or edit the configuration_template.yaml
available in the conf
directory. You have to update at least the following parameters:
# Input DSM path (expected format: "<folder_1>/<folder_2>/<file>.<[tif/tiff]>")
dsm_path : "<input_dsm.tif>"
# Output directory path (if the directory doesn't exist, create it)
output_dir : "<output_dir>"
Run the pipeline:
bulldozer --conf conf/configuration_template.yaml
from bulldozer.pipeline.bulldozer_pipeline import dsm_to_dtm
dsm_to_dtm(config_path="conf/configuration_template.yaml")
* Through Python API providing directly the input parameters (missing parameters will be replaced by default values)
```python
from bulldozer.pipeline.bulldozer_pipeline import dsm_to_dtm
# Example with a specific number of workers
dsm_to_dtm(dsm_path="<input_dsm.tif>", output_dir="<output_dir>", nb_max_workers=16)
✅ Done! Your DTM is available in the
For each section described in Key Features section you can follow one of the tutorial notebook:
Bulldozer also has a more detailed documentation.
A high-level overview of how it’s organized will help you know where to look for certain things:
NOTE: The documentation is not available online yet, it needs to be built manually.
To do so, please execute the following command at the root:
mkdocs serve
To do a bug report or a contribution, see the Contribution Guide.
for any help or suggestion, feel free to contact the authors:
Bulldozer has a Apache V2.0 license, as found in the LICENSE file.
Please refer to the Authors file.