babiskir/wave-model

Wave model simulator used in master project and master thesis

MCSimPython

Vessel simulator used in master project and master thesis of M. Kongshaug, H. Mo and J. Hygen. The project is developed at Norwegian University of Science and Technology, Institue of Marine Technology.

The python package is not complete and there is no guarantee for the validity of the vessel models.

The complete documentation can be found at: https://wave-model.readthedocs.io/en/latest/index.html

How to use MCSimPython

PyPi

The MCSimPython package can be installed from PyPi using pip:

pip install MCSimPython

From GitHub:

Install from GitHub in the following:

• Clone the GitHub repository to your local computer.
• Create a virtual environment py -m venv name-of-venv
• Activate virtual environment name-of-venv\scripts\activate
• Update pip and setuptools: py -m pip install --upgrade pip setuptools
• Install the python package locally: pip install . (alternatively you can install as an editable pip install -e .)
• Verify that the python package MCSimPython has been installed properly by running a demo script, or simply in the command promt:

(venv) C:\path\to\dir> python
>>> import MCSimPython
>>>

Demos

Demonstration of how the individual components of the python package can be used is given in demos. Some demos of combination of the different components are also given here.

Visualization

RVG 6DOF model in beam sea

RVG 6DOF model in head sea