A Python package of ship maneuvering simulation
Project description
ShipMMG: Ship Maneuvering Simulation Model
What is it?
ShipMMG is a unofficial Python package of ship maneuvering simulation with respect to the research committee on “standardization of mathematical model for ship maneuvering predictions” was organized by the JASNAOE.
Where to get it
The source code is currently hosted on GitHub at: https://github.com/ShipMMG/shipmmg
Binary installers for the latest released version will be available at the Python package index. Now, please install pDESy as following.
pip install shipmmg
# pip install git+ssh://git@github.com/ShipMMG/shipmmg.git # Install from GitHub
# conda install -c conda-forge -c taiga4112 shipmmg # Install from Anaconda
License
For developers
Developing shipmmg API
Here is an example of constructing a developing environment.
docker build -t shipmmg-dev-env .
docker run --rm --name shipmmg-dev -v `pwd`:/code -w /code -it shipmmg-dev-env /bin/bash
In this docker container, we can run pytest for checking this library.
Checking shipmmg API
Here is an example of checking the shipmmg developing version using JupyterLab.
docker-compose build
docker-compose up
After that, access http://localhost:8888.
- Password is
shipmmg.
Contribution
- Fork it ( http://github.com/ShipMMG/shipmmg/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request
If you want to join this project as a researcher, please contact me.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
