.. _output_files:
===========
Output files
===========

The Ship Traffic Generator creates output files according to
the open-source `maritime schema`_ `Traffic Situation`_ format.

.. _maritime schema: https://dnv-opensource.github.io/maritime-schema/
.. _Traffic Situation: https://dnv-opensource.github.io/maritime-schema/traffic_situation/

Below is one example of an output file created by the Ship Traffic Generator.
This describes the starting position of the ownship (ship under test)
and one target ship, and their planned goal positions, for a head-on (HO) encounter.
Note that the first waypoint is typically set to the initial waypoint.
The `targetShips` field can contain multiple target ships,
at different COLREG encounter courses.

Example 1: Output file generated by the Ship Traffic Generator::

    {
        "version": "0.8.1",
        "title": "HO",
        "description": "A head on situation with one target ship.",
        "ownShip": {
            "initial": {
                "position": {
                    "lon": 10.490654,
                    "lat": 58.763449
                },
                "sog": 10.0,
                "cog": 0.0,
                "heading": 0.0,
                "navStatus": "Under way using engine"
            },
            "waypoints": [
                {
                    "position": {
                        "lon": 10.490654,
                        "lat": 58.763449
                    }
                },
                {
                    "position": {
                        "lon": 10.490654,
                        "lat": 58.8465724
                    }
                }
            ],
            "static": {
                "id": 1,
                "mmsi": 257847600,
                "name": "BASTO VI",
                "dimensions": {
                    "length": 122.0,
                    "width": 20.0,
                    "height": 8.0,
                    "a": 61.0,
                    "b": 61.0,
                    "c": 10.0,
                    "d": 10.0
                },
                "shipType": "Passenger"
            }
        },
        "targetShips": [
            {
                "initial": {
                    "position": {
                        "lon": 10.49680582,
                        "lat": 58.85500037
                    },
                    "sog": 12.1,
                    "cog": 183.63,
                    "heading": 183.63,
                    "navStatus": "Under way using engine"
                },
                "waypoints": [
                    {
                        "position": {
                            "lon": 10.49680582,
                            "lat": 58.85500037
                        }
                    },
                    {
                        "position": {
                            "lon": 10.48458595,
                            "lat": 58.75501409
                        }
                    }
                ],
                "static": {
                    "id": 2,
                    "name": "target_ship_1",
                    "dimensions": {
                        "length": 122.0,
                        "width": 20.0,
                        "height": 8.0,
                        "a": 61.0,
                        "b": 61.0,
                        "c": 10.0,
                        "d": 10.0
                    },
                    "shipType": "Passenger"
                }
            }
        ]
    }