# MCSimPython
[](https://www.gnu.org/licenses/gpl-3.0) [](https://www.python.org/downloads/release/python-380/) [](https://www.python.org/downloads/release/python-390)
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
<!---
### CSAD 6DOF model in multidirectional sea
--->
Raw data
{
"_id": null,
"home_page": "",
"name": "MCSimPython",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "mcsim,MCSimPython,DP,dynamic positioning,Marine Cybernetics",
"author": "",
"author_email": "Jan-Erik Hygen <janereh@stud.ntnu.no>",
"download_url": "https://files.pythonhosted.org/packages/96/6d/26f6119e77d5f132cb799218bf44c70d86ad307664afeb2fb7565784f18d/MCSimPython-0.1.5.tar.gz",
"platform": null,
"description": "# MCSimPython\n\n[](https://www.gnu.org/licenses/gpl-3.0) [](https://www.python.org/downloads/release/python-380/) [](https://www.python.org/downloads/release/python-390)\n\nVessel 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. \n\nThe python package is not complete and there is no guarantee for the validity of the vessel models.\n\nThe complete documentation can be found at: https://wave-model.readthedocs.io/en/latest/index.html\n\n## How to use MCSimPython\n\n### PyPi\nThe `MCSimPython` package can be installed from PyPi using `pip`:\n\n`pip install MCSimPython`\n\n### From GitHub:\nInstall from GitHub in the following:\n- Clone the GitHub repository to your local computer.\n- Create a virtual environment `py -m venv name-of-venv`\n- Activate virtual environment `name-of-venv\\scripts\\activate`\n- Update pip and setuptools: `py -m pip install --upgrade pip setuptools`\n- Install the python package locally: `pip install .` (alternatively you can install as an editable `pip install -e .`)\n- Verify that the python package `MCSimPython` has been installed properly by running a demo script, or simply in the command promt:\n```\n(venv) C:\\path\\to\\dir> python\n>>> import MCSimPython\n>>>\n```\n\n## Demos\n\nDemonstration 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. \n\n## Visualization\n\n### RVG 6DOF model in beam sea\n\n\n### RVG 6DOF model in head sea\n\n\n<!---\n### CSAD 6DOF model in multidirectional sea\n\n--->\n",
"bugtrack_url": null,
"license": "",
"summary": "Python vessel simulation environment",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [
"mcsim",
"mcsimpython",
"dp",
"dynamic positioning",
"marine cybernetics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7818318a0c75a6901a2a02d1a25bb70c0f522d5ae4b13e34b1dd3316097b03d8",
"md5": "a5d9624d11d6795e7eb3f4cac55f6a34",
"sha256": "600a674cb43aa246235d82ce5ba7c6176f036015a3ece00694841c23da1a30e0"
},
"downloads": -1,
"filename": "MCSimPython-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a5d9624d11d6795e7eb3f4cac55f6a34",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8528206,
"upload_time": "2023-05-09T16:23:53",
"upload_time_iso_8601": "2023-05-09T16:23:53.624902Z",
"url": "https://files.pythonhosted.org/packages/78/18/318a0c75a6901a2a02d1a25bb70c0f522d5ae4b13e34b1dd3316097b03d8/MCSimPython-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "966d26f6119e77d5f132cb799218bf44c70d86ad307664afeb2fb7565784f18d",
"md5": "661429bf5b7d53077a71e8f3dbcf63e0",
"sha256": "f078f52e27b8443376a32f18857120f0be8c7a3c64a1f81e416d5bcfcbe68159"
},
"downloads": -1,
"filename": "MCSimPython-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "661429bf5b7d53077a71e8f3dbcf63e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8470556,
"upload_time": "2023-05-09T16:23:56",
"upload_time_iso_8601": "2023-05-09T16:23:56.554049Z",
"url": "https://files.pythonhosted.org/packages/96/6d/26f6119e77d5f132cb799218bf44c70d86ad307664afeb2fb7565784f18d/MCSimPython-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-09 16:23:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mcsimpython"
}
JSON