.. MariTEAM Analytics Tools documentation master file, created by
   sphinx-quickstart on Tue Nov 12 08:06:29 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MariTEAM Analytics Tools (Mastin)
====================================================

.. toctree::
   :numbered:
   :titlesonly:
   :maxdepth: 3
   :caption: Contents:


Authentification
================
.. automodule:: mastin.login
   :members:

Code example
------------

Authenticate user

.. code-block:: python
   :linenos:

   from mastin import login

   login.authentificate('user@email.my', 'password')


Ships
=====
.. automodule:: mastin.ships
   :members:

Code example
------------

Show Ship model schema

.. code-block:: python
   :linenos:

   from mastin.ships import Ship

   dict(Ship.schema())

Create empty ship
*The MMSI is autogenerated and must not be changed*

.. code-block:: python
   :linenos:

   from mastin import ships

   ship = ships.create_empty_ship()
   # Modify ship's parameters
   ship.length = 120
   ship.ship_type = 'container'
   # print ship object
   ship


Ship Model
==========
.. automodule:: mastin.models.ship
   :members:


Operational Profiles
====================
.. automodule:: mastin.operational_profiles
   :members:


Operational Profile Model
==========================
.. automodule:: mastin.models.operational_profile
   :members:



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

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