https://github.com/dnv-opensource/maritime-schema
Python package containing data classes and corresponding JSON schemata for common types used in generating traffic scenarios and testing of autonomy
https://github.com/dnv-opensource/maritime-schema
Last synced: about 1 year ago
JSON representation
Python package containing data classes and corresponding JSON schemata for common types used in generating traffic scenarios and testing of autonomy
- Host: GitHub
- URL: https://github.com/dnv-opensource/maritime-schema
- Owner: dnv-opensource
- License: mit
- Created: 2024-01-11T14:36:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T07:46:45.000Z (about 2 years ago)
- Last Synced: 2024-05-02T21:27:28.341Z (about 2 years ago)
- Language: Python
- Size: 821 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Maritime Schema
[**maritime-schema**](https://dnv-opensource.github.io/maritime-schema/) is a DNV initiative that establishes open formats and interfaces for collision avoidance testing, enabling industry collaboration in the field of Autonomous and Remotely Operated Ships.
The goal is to enable industry partners to share maritime traffic situations, and collision avoidance manuevers (or solutions) to these.
Schemas and their corresponding documentation can be viewed [here](https://dnv-opensource.github.io/maritime-schema/).
- Schemas are located in the `schema` folder:
- [`schema/traffic_situation.json`](docs/schema/traffic_situation.html)
- [`schema/situation_output.json`](docs/schema/traffic_situation.html)
- Schema HTML documentation is located in the `docs/schema` folder.
- [`docs/schema/traffic_situation.html`](docs/schema/traffic_situation.html)
- [`docs/schema/situation_output.html`](docs/schema/traffic_situation.html)
**Note**
Prior to release 0.0.7, maritime-schema also included pydantic classes for creating a schema in python. These have been migrated to [ship-traffic-gen](https://github.com/dnv-opensource/ship-traffic-generator/blob/main/src/trafficgen/types.py).
## Bulding the site
This repository contains the source code for the maritime-schema static site, built with Jekyll and hosted on GitHub Pages.
To build this site, please follow the instructions below.
### Prerequisites
Make sure you have the following installed on your local machine:
- Ruby
- Bundler
- Jekyll
### Installation
1. **Clone the repository:**
```sh
git clone https://github.com/dnv-opensource/maritime-schema.git
cd maritime-schema
```
2. **Install the dependencies:**
```sh
bundle install
```
### Usage
To serve the site locally, run:
```sh
bundle exec jekyll serve