Skip to content

Quick Start

Make sure beratools is installed. Run the command in MiniConda/Anaconda Prompt to start BERA Tools main gui.

$ conda activate bera
$ beratools

Example Data

Start working with BERA Tools using example data.

Download latest example data

Main GUI

BERA Tools provide a light weight GUI to use tools.

Main GUI

The BERA Tools main GUI consists of the following components:

Panel / Section Description
Tool Selection Panel (Left) A tree view listing all available tools, organized by toolbox. Users can search for tools using the search bar at the top. Selecting a tool updates the main panel.
Tool History Panel (Left, below tool selection) Displays a list of recently used tools for quick access, with options to clear or remove items.
Main Panel (Right) Top Section: Shows the currently selected tool name, with buttons for advanced options, viewing code, and help.
Tool Parameters: Dynamic widgets for entering parameters required by the selected tool.
Bottom Section: Includes a slider to select the number of CPU cores, a button to load default arguments, and buttons to run or cancel the tool.
Output and Progress (Bottom Right) A text area displays output, logs, and messages from tool execution.
A progress bar and label show the status of running tools.

Workflow Diagram

graph TD
    A["Check Seed Line"] --> B["Vertex Optimization"]
    B --> C["Centerline"]
    A --> C["Centerline"]
    C --> D1["Canopy Footprint<br/>Absolute"]
    C --> D2["Canopy Footprint<br/>Relative"]
    D1 --> E["Ground Footprint"]
    D2 --> E["Ground Footprint"]
    %% Style optional step (Vertex Optimization)
    style B fill:#eee,stroke:#aaa,color:#666,stroke-width:1px,stroke-dasharray:5 5;
    click A "../user/check_seed_line" "Check Seed Line"
    click B "../user/vertex_optimization" "Vertex Optimization"
    click C "../user/centerline" "Centerline"
    click D1 "../user/canopy_footprint_abs" "Canopy Footprint Absolute"
    click D2 "../user/line_footprint_rel" "Canopy Footprint Relative"
    click E "../user/ground_footprint" "Ground Footprint"

Data Preparation

BERA Tools start with two main types of input data:

  • CHM (GeoTIFF).
  • Seed Lines (polylines): rough centerlines of seismic lines, which helps to detect accurate centerline.

Ensure your input data meets the following criteria:

  • Vector Format: Supported vector formats include GeoPackage (.gpkg), Shapefile (.shp).
  • Raster Format: Supported raster formats include GeoTIFF (.tif).
  • Coordinate System: Data should be in a projected coordinate system (e.g., UTM) for accurate distance measurements.