.. shipmmg documentation master file, created by
   sphinx-quickstart on Fri Jan  8 17:57:59 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

shipmmg: A Python package of ship maneuvering simulation
===========================================================

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.

.. image:: https://github.com/ShipMMG/shipmmg/workflows/codecov/badge.svg


.. image:: https://codecov.io/gh/ShipMMG/shipmmg/branch/main/graph/badge.svg?token=VQ1J2RTC7X
   :target: https://codecov.io/gh/ShipMMG/shipmmg
    

Install
--------

.. code-block:: bash

   pip install shipmmg
   # pip install git+https://git@github.com/ShipMMG/shipmmg.git # INSTALL FROM GITHUB

.. toctree::
   :maxdepth: 2
   :caption: Contents:

How to use shipmmg?
--------------------

Comming soon.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`