xdyn is a lightweight ship simulator modelling the dynamic behaviour of a ship at sea, with its actuators, including some non-linear aspects of that behaviour and featuring a customizable maneuvring model. It simulates the mechanical behaviour of a solid body in a fluid environment by solving Newton's second law of motion, taking hydrodynamic forces into account.
It was developed by SIREHNA through both self-funded projects and various collaborative projects, including the IRT Jules Verne's "Bassin Numérique" project.
(c) 2014-2015, IRT Jules Verne, SIREHNA, Naval Group, Bureau Veritas, Hydrocean, STX France, LHEEA for the initial version.
(c) 2015-2018 SIREHNA & Naval Group for all subsequent versions.
Disclaimer: Documentation was written for a French project, with French participants, therefore it is in French. It will be translated eventually. Also, please note that it is still a work-in-progress and, as such, can be incomplete. Despite our best efforts, inaccuracies may remain. However, the documentation will continue to evolve as new developments on xdyn are on-going.
The easiest way to run xdyn is to use Docker:
docker run sirehna/xdyn
This does not require installing or downloading anything except Docker itself.
Pre-built binaries of xdyn are also available:
There are many other ways of using xdyn, all of which are described in the documentation.
The models implemented inside xdyn are described in detail from section 11 to section 13 of the documentation. You can also learn how to use xdyn using the tutorials.
This section describes what you need to do if you wish to compile xdyn yourself. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
To build xdyn, the easiest is to use Docker.
Depending on your platform, please refer to:
- Get Docker CE for CentOS
- Get Docker CE for Debian
- Get Docker CE for Fedora
- Get Docker CE for Mac
- Install Docker for Windows
You also need make.
Once Docker is installed, use:
make
to build both the Windows & the Debian versions.
If you only want one of the two versions, you can use:
make debian
or
make windows
which performs a cross-compilation for Windows using GCC.
The binaries can then be found in build_windows or build_debian,
respectively.
If you wish to build only part of the project, use:
./ninja_windows.sh package
for example, to build the Windows package (ZIP file containing the xdyn executable)
or
./ninja_debian.sh run_all_tests
to rebuild the Debian tests.
Once the build has finished, you can run the tests.
To run the tests for Debian use:
./run_all_tests_debian.sh
To run the Windows tests (using Wine in a Docker container) enter:
./run_all_tests_windows.sh
The tests are written using Google test. These are both end-to-end tests and unit tests. The end-to-end tests can be a bit long so you can disable them using Google tests filters:
./run_all_tests_debian.sh --gtest_filter=-'*LONG*'
All arguments after the script name are passed to the GTest executable. Please refer to the Google Test documentation for details and other available options.
Add additional notes about how to deploy this on a live system.
- CMake - Used to compile C++ code for various platforms.
- Make - Used for the one-step build described above.
- GCC - Compiler used for both the Windows & Linux: Visual Studio is currently not supported.
- Boost - For command-line options, regular expressions, filesystem library.
- yaml-cpp - To parse the input files.
- HDF5 - To store the outputs.
- Eigen - For matrix manipulations.
- Pandoc - To generate the documentation.
- Pweave - To generate the tutorials.
- SSC - For websockets, units decoding, interpolations, kinematics, CSV file reading and exception handling.
Please read CONTRIBUTING.md for details on how to submit issues & pull requests to xdyn. Our code of conduct is the Contributor Covenant (original version available here ).
We use SemVer for versioning. For the versions available, see the tags on this repository.
See also the list of contributors who participated in this project.
This project is licensed under the Eclipse Public License (version 2) - see the LICENSE.md file for details.