1. 3Di instruments and downloads

Please visit 3Di start for an overview of all 3Di instruments and portals.

Below we explain how to install the Modeller Interface or QGIS with plugins and how to install and configure TortoiseHG. We also show you how to download the database overview or an empty database.

To use 3Di you need these software packages:

  • Recent version of Google Chrome (Get Chrome)

  • The ‘Modeller Interface’ or install a recent version of QGIS with the appropriate plugins.

  • Recent version of TortoiseHG

Note

Are you running into problems when downloading or updating the software? Please contact our support office (servicedesk@nelen-schuurmans.nl)

1.1. Modeller Interface or QGIS

  • Install the Modeller Interface or

  • Install the Long Term Release (LTR) of QGIS, and install the 3Di toolbox and API client as QGIS plugins

1.1.1. Plugin Installation

  • QGIS 3.16 64bit Long term release (Get QGIS and use the standalone installer)

    After the installation of QGIS, set the interface language and locale to American English. This makes it easier to understand the instructions in this documentation. Some locales do not support scientific notations of numbers, these are required for very small numbers (e.g. 1e-09).

    • Go to Settings > Options > General

    • Tick the box ‘Override System Locale’

    • For User Interface Translation, choose ‘American English’

    • For Locale, choose ‘English UnitedStates (en_US)’

    • Restart QGIS

  • QGiS 3Di plug-in specially designed for 3Di

    • 3Di Toolbox

    • 3Di API client

The plugins work for:

  • QGIS 3.16.x (LTR after March 2021)

  • 64-bit version of QGIS (see below for more details)

  • On Linux/OSX: install the following system dependencies: python3-h5py python3-scipy python3-pyqt5.qtwebsockets

  • 3Di v2 results

To install the 3Di-Toolbox plugin follow the steps below:

  1. Open QGIS and via the menu bar go to ‘Plugins > Manage And Install Plugins’.

  2. Go to ‘Settings’.

  3. Add a plugin repository

  4. Fill in a name and copy the URL: https://plugins.3di.live/plugins.xml into the URL box.

  5. Go to ‘All’ and choose ‘3Di toolbox’ from the list

  6. Install the plugin.

QGIS Plugin Manager
Add Lizard repo Plugin
Install 3Di Toolbox

To install the 3Di API client plugin follow the steps below:

  1. Open QGIS and via the menu bar go to ‘Plugins > Manage And Install Plugins’.

  2. Go to ‘Settings’.

  3. Add a plugin repository

  4. Fill in a name and copy the URL: https://plugins.lizard.net/plugins.xml into the URL box.

  5. Go to ‘All’ and choose ‘3Di API client’ from the list

  6. Install the plugin.

  7. To active the panel of the API client, choose plugins –> 3Di API client –> 3Di API client. Now the panel will be available.

1.2. TortoiseHG

Get TortoiseHG

After installation of TortoiseHG the program can be started by selecting the TortoiseHg Workbench program from the Windows Start menu. In a first use, activate the ‘large files extension’ by selecting from the File menu ‘Settings’ and then’ Extensions’ and select ‘large files’. Also fill in your name. Press OK and restart TortoiseHG.

Extensions

Tortoise also has a built-in encrypted password manager, allowing you to push and pull revisions without being prompted for your username and password each time. To enable the password manager:

  • Open TortoiseHg Workbench

  • Go to File > Settings > Extensions

  • Check the box ‘mercurial_keyring’.

  • Restart TortoiseHg Workbench

  • Now you still have to enable the password manager for each repository you clone, see Download 3Di repository using TortoiseHG Workbench

1.3. Database

1.3.1. Database overview

The database overview shows the complete overview of tables that 3Di uses in the spatialite database. You can download the complete overview of tables that 3Di uses in the spatialite database here. Also, this flowchart may help you while editing your model. The following links show you the database schema’s for sewerage and surface water.

1.3.2. Empty database

If you like to set up a new model it may be helpful to start from an empty database. Download an empty spatialite database here.

Please be aware not to add any columns to existing tables in the spatialite as they may interfere with future migrations.