Skip to main content

A Python package of ship maneuvering simulation

Project description

ShipMMG: Ship Maneuvering Simulation Model

PyPI version Anaconda-Server Badge codecov codecov

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

MIT

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

  1. Fork it ( http://github.com/ShipMMG/shipmmg/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

If you want to join this project as a researcher, please contact me.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shipmmg-0.0.10.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

shipmmg-0.0.10-py3-none-any.whl (22.0 kB view details)

Uploaded Python 3

File details

Details for the file shipmmg-0.0.10.tar.gz.

File metadata

  • Download URL: shipmmg-0.0.10.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.6 Linux/5.15.0-56-generic

File hashes

Hashes for shipmmg-0.0.10.tar.gz
Algorithm Hash digest
SHA256 480605436c6b0363f259c732202ded3d374aef827dce54f7a2266689188e7683
MD5 aa17e21a79c897dbc08d21a48e1d413f
BLAKE2b-256 b174f9d1e21fcce6b8a85823d26a192a30128f95fae046c54be387d84aa9105f

See more details on using hashes here.

File details

Details for the file shipmmg-0.0.10-py3-none-any.whl.

File metadata

  • Download URL: shipmmg-0.0.10-py3-none-any.whl
  • Upload date:
  • Size: 22.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.6 Linux/5.15.0-56-generic

File hashes

Hashes for shipmmg-0.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 3c0450cccec2b134055f6effb0dd4143b81b7297fd7aefbe0f32e489a5f64d71
MD5 246bee8ffb7bdf98a024c5cae8006b6b
BLAKE2b-256 ec3a5d7b388825b8d56f51d6f0bc49f8e2eb853d5af2e527d6e25d78b3262cee

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page