Introduction

This Implementation Manual is a part of the total material to implement the SWAN wave model on your computer system. The total material consists of:

• the SWAN source code,
• the pre-built SWAN release for Windows,
• the User Manual,
• this Implementation Manual,
• the Scientific/technical documentation,
• the SWAN programming rules,
• utilities and
• some test cases.

All of the material can be found at the official SWAN homepage.


Since version 41.41, the SWAN source code is also hosted on GitLab and can be cloned from this repository. For details see Section 3.3.


On the SWAN homepage, general information is given about the model functionalities, physics and limitations of SWAN. Also, the modification history (or release notes) of SWAN and information on support are provided.


After downloading the material, you may choose between

• direct usage of the pre-built SWAN for Windows and
• implementation of SWAN on your computer system.

If you want to use the pre-built SWAN please read Chapters 5 and 6 for further information.


For the purpose of implementation, you have access to the source code of SWAN and additional files, e.g. for testing SWAN. Please read the copyright in this manual and in the source code with respect to the terms of usage and distribution of SWAN. You are permitted to implement SWAN on your computer system. However, for any use of the SWAN source code in your environment, proper reference must be made to the origin of the software.


Implementation involves the following steps:

1. Copying the source code from the SWAN homepage to the computer system on which you want to run SWAN.
2. If necessary, applying patches for an upgrade of the source code due to e.g., bug fixes, resolved issues, new features, etc.
3. Making a few adaptions in installation-dependent parts of the code.
4. Compiling and linking the source code to produce an executable of SWAN.
5. Testing of the built SWAN.

After the last step you should have the built SWAN ready for usage. Note that steps 3 and 4 can be carried out fully automatically.