2. Registration

Follow the instructions at "Get started, How to register".

3. Download Source Code

After registration you can access the Subversion repository. Use your internet browser to have a look at "https://svn.oss.deltares.nl". Repository "Delft3D" contains branches (isolated develop versions), tags (fully tested, stable versions) and the trunk (where all updates, merges and bug fixes happen). Choose a version you want to download. As a start, use a stable, fully tested version from the tags, for example "https://svn.oss.deltares.nl/repos/delft3d/tags/6686". The best version currently available is the tagged version with the highest version number.

Remark about the version numbering in "tags": Tag "2367"  and up contain DELWAQ, Delft3D-FLOW and Delft3D-WAVE. Since all these modules have their own version number, the name of the tag is simply the related revision number in the trunk. The log of the tag contains a full list of version numbers, for example, the log of tag "2367" reads:
DELWAQ       Version 5.00.00.2367
Delft3D-FLOW Version 6.00.00.2367
Delft3D-WAVE Version 3.04.01.2367

Using TortoiseSVN (Windows only)

TortoiseSVN is a convenient SVN client for Windows that integrates with Windows Explorer.

Go to Windows Explorer (hit WIN+E or right-click on the Start button and click Explore), and create a new folder in a location of your choice. You may want to name it something like "delft3d_repository."
WARNING: Avoid using a directory name containing spaces.

Right click on that folder and choose "SVN Checkout". Use The URL of your choice, for example "https://svn.oss.deltares.nl/repos/delft3d/tags/6686 ". Click "Ok" to download this version of the source code.

You will now be prompted for your username and password (these are the same as your credentials for the community environment).

The download will start automatically.

See the manual of TortoiseSVN for more information.

Using Subversion (Linux and Windows)

Choose a directory where you want the source code to be placed and execute the checkout command. Example (to put the source code in the newly created directory "delft3d_repository"):

svn checkout https://svn.oss.deltares.nl/repos/delft3d/tags/6686 delft3d_repository

You will now be prompted for your username and password (these are the same as your credentials for the community environment).

The download will start automatically.

See the manual of Subversion for more information.

4. Compile the source code

Windows only (revision 5382 and up):
By running a Python script, a solution file will be generated and the project files will be adjusted to the tools that you use.

Linux and Windows:
See file "src/README", inside the downloaded code, for the compile instructions. On Windows, start with the release version.

In case of problems:

  1. Check that you are using the correct tools, see prerequisites

  2. Check the Frequently Asked Questions page

5. Run a calculation

Always start by running one of the examples inside the downloaded source code using the prepared run-script. If this works fine, the binaries were build correctly.

In the description below, the term "myCode" is used for the location/directory on your machine where you have chosen to download the source code.
The term "myDelft3D" is used for the location/directory on your machine where you have chosen to install the Delft3D setup containing the GUIs. The default value for "myDelft3D" is "c:\Program Files (x86)\Deltares\Delft3D 4.xx.xx" on Windows and "/opt/delft3d" on Linux.

The description below is based on source code version 5.00.00.1234 and higher.

5.1 Running Delft3D-FLOW, Delft3D-WAVE and D-Water Quality using scripts (Windows and Linux)

Assumption on the compilation part:
On Windows, the release version is built.
On Linux, the "build.sh" script is used or the command "make ds-install" is executed.


After compiling the source code:
Go to one of the sub-directories of "examples", inside the downloaded source code: "myCode/examples".
Windows: execute "run_***.bat".
Linux: execute "run_***.sh".
Testcase "myCode/examples/01_standard" also contains example run scripts for parallel calculations.
For your own testcase: copy and adapt both "config_d_hydro.xml" (in version 5.xx and 4.xx "config_flow2d3d.ini") and "run_flow2d3d.bat/sh" into your testcase directory.

If the testcase does not run, the two most common problems are :

  1. The binaries are not build correctly.
    Windows: Does directory "myCode/bin/win64/flow2d3d/bin" contain the binaries "d_hydro.exe" and "flow2d3d.dll"? If not, something went wrong during compilation. Check the output window inside Visual Studio.
    Linux: Does directory "myCode/bin/lnx64/flow2d3d/bin" contain the binaries "d_hydro.exe" and "libflow2d3d.so"? If not, something went wrong during compilation. Check the log files in directory "myCode/src/logs".

  2. System and/or compiler specific libraries can not be found.
    Normally these libraries are found via some environment parameters (PATH and LD_LIBRARY_PATH). Problems may occur when porting binaries to a machine without development tools. Especially when FLOW runs online with WAVE, finding the correct compiler specific libraries is sensitive.
    All needed system/compiler specific libraries are copied into directory "myCode/bin/<platform>/***/bin" during installation. Thus creating a set of binaries that can be distributed to other machines.
    Windows: Normally a message window appears to notify what library is missing.
    Linux: Use the ldd command to find out what library is missing.

     

5.2 Running Delft3D-FLOW, Delft3D-WAVE and D-Water Quality using the GUI menu (Delft3D version 4.01 and higher)

Start by obtaining and installing the Delft3D-GUI. See the box named "TEMPORARY EXTRA SERVICE" at the top of the current page. This box is only visible while being signed in. After installation, the Delft3D-menu can be started, but the GUI does not contain the open source binaries. You have to compile them yourself and copy them into the GUI directory as follows:

First compile the source code and check that the binaries are correct by running a calculation with a script as described above. If that works fine, you have to copy the binaries from "myCode/bin" into "myDelft3D" as descibed below:

Windows: Directory "myCode/bin/" contains a subdirectory named "win64". Copy this directory "myCode/bin/win64" to "myDelft3D/win32", replacing existing files (create a backup version first in case of doubt).
Linux: Directory "myCode/bin/" contains a subdirectory named "lnx64". Copy this directory "myCode/bin/lnx64" to "myDelft3D/lnx64", replacing existing files (create a backup version first in case of doubt).

Start the Delft3D-menu:
Windows: Execute "myDelft3D/win32/d3d_menu.bat". See the manuals for more details.
Linux: "Dot" the profile and start the menu, using the following two commands:
. /myDelft3D/etc/profile.d/delft3d.sh
delft3d-menu

See the manuals for more details.

6. Known problems

1

"DomainDecomposition on multiple nodes" does not working properly.

2

"OnlineVisualisation on Delft3D-FLOW" has been replaced by RemoteOLV and is still unstable.