maritime-schema 0.0.4

Python data classes and JSON schemata for maritime traffic scenarios.

maritime-schema

Python package containing data classes and corresponding JSON schemata for common types used in generating traffic scenarios and testing of autonomous navigation systems.

The data classes in the package are implemented as data models using the pydantic framework.
All data classes reside in subpackage maritime_schema.types and can be imported from there.

Installation

pip install maritime-schema

Usage Example

API:

from maritime_schema.types import ...

CLI:

The JSON schemata are contained in the repository in folder ./schema If you did not clone the repository but installed the maritime-schema package as a dependency in your project you can call publish-schema on the command line to (re-)generate the schemata:

publish-schema

The publish-schema command will generate the JSON schemata in (current working directory)/schema
and a corresponding html documentation of the schemata in (current working directory)/docs/schema

For more examples and usage, please refer to maritime-schema's documentation.

Development Setup

1. Install Python 3.9 or higher, i.e. Python 3.10 or Python 3.11

2. Update pip and setuptools:

   python -m pip install --upgrade pip setuptools
   

3. git clone the maritime-schema repository into your local development directory:

   git clone https://github.com/dnv-opensource/maritime-schema path/to/your/dev/maritime-schema
   

4. In the maritime-schema root folder:

   Create a Python virtual environment:

   python -m venv .venv
   

   Activate the virtual environment:

   ..on Windows:

   > .venv\Scripts\activate.bat
   

   ..on Linux:

   source .venv/bin/activate
   

   Update pip and setuptools:

   (.venv) $ python -m pip install --upgrade pip setuptools
   

   Install maritime-schema's dependencies:

   (.venv) $ pip install -r requirements-dev.txt
   

   This should return without errors.

   Finally, install maritime-schema itself, yet not as a regular package but as an editable package instead, using the pip install option -e:

   (.venv) $ pip install -e .
   

5. Test that the installation works (in the maritime-schema root folder):

   (.venv) $ pytest .
   

Meta

Copyright (c) 2024 DNV AS. All rights reserved.

Minos Hemrich - [e-mail]

Tom Arne Pedersen - [e-mail]

Claas Rostock - @LinkedIn - [e-mail]

Distributed under the MIT license. See LICENSE for more information.

https://github.com/dnv-opensource/maritime-schema

Contributing

1. Fork it (https://github.com/dnv-opensource/maritime-schema/fork)
2. Create your branch (git checkout -b my-branch-name)
3. Commit your changes (git commit -am 'place a descriptive commit message here')
4. Push to the branch (git push origin my-branch-name)
5. Create a new Pull Request in GitHub

For your contribution, please make sure you follow the STYLEGUIDE before creating the Pull Request.