Skip to content

Documentation and bug fix ready to be merged #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tomarnepedersen merged 19 commits into from
Oct 6, 2025
Merged

Documentation and bug fix ready to be merged #74

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
8a0e05a
Fixed bug #68, target ships within one situation now have different i…
tomarnepedersen Sep 22, 2025
94cfbd3
While working on #68, some warnings was issued. Fix it.
tomarnepedersen Sep 22, 2025
eae08a1
#68, updated changelog
tomarnepedersen Sep 22, 2025
1d281e5
add documentation on output files (new page), add links to maritime s…
StephanieKemna Sep 23, 2025
ee3f83d
Merge pull request #72 from dnv-opensource/71-add-example-output-to-d…
StephanieKemna Sep 23, 2025
2da99f8
#68 Fixing comment from reviewer. Updated generated files.
tomarnepedersen Sep 24, 2025
7692fd6
Merge branch 'dev' into 68-ts-id-numbers-are-same-in-output-situation…
tomarnepedersen Sep 24, 2025
63b31c2
Merge pull request #69 from dnv-opensource/68-ts-id-numbers-are-same-…
tomarnepedersen Sep 24, 2025
d257dab
Updated before release
tomarnepedersen Sep 24, 2025
af6f7f8
Update docs/source/output_files.rst
StephanieKemna Oct 3, 2025
d543e0f
Update docs/source/output_files.rst
StephanieKemna Oct 3, 2025
2e27f85
clarify that an output folder needs to be specified in order for file…
StephanieKemna Oct 3, 2025
5c0745b
reference source MSS
StephanieKemna Oct 3, 2025
955815d
markdownlint; add newlines, add example PR test procedure
StephanieKemna Oct 3, 2025
615a733
Merge branch 'dev' of github.com:dnv-opensource/ship-traffic-generato…
StephanieKemna Oct 3, 2025
1f11358
fix ruff complaint that I caused, and edit printout because you could…
StephanieKemna Oct 3, 2025
05f9a1d
Updated doc file and changelog
tomarnepedersen Oct 3, 2025
47d609a
updates after running ruff and pyright
tomarnepedersen Oct 3, 2025
86a0158
Updated text
tomarnepedersen Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,14 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e

## [Unreleased]

## [0.8.2] - 2025-09-24
* [bug] fixed bug that all target ships had id = 10.
* [bug] fixed duplicate -v parameter warning.
* If own ship ID is not given in own_ship.json file, then ID is set to 1. Target ship IDs will follow from own ship ID.
* Better documentation of output files, added links to maritime schema, and improved navigation between related sections.

## [0.8.1] - 2025-05-12
* Changed first assert in test_basic_cli() from 0 to 2.
* Changed first assert in test_basic_cli() from 0 to 2.

## [0.8.0] - 2025-05-09

Expand Down
6 changes: 3 additions & 3 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ authors:
email: Minos.Hemrich@dnv.com
affiliation: DNV
testers:
- given-names: Grunde
family-names: Løvoll
- given-names: Melih
family-names: Akdag
affiliation: DNV
- given-names: Stephanie
family-names: Kemna
Expand All @@ -36,4 +36,4 @@ keywords:
- Systematic assessment
license: MIT
url: 'https://github.com/dnv-opensource/ship-traffic-generator'
version: 0.7.2
version: 0.8.2
20 changes: 10 additions & 10 deletions data/baseline_situations_generated/traffic_situation_01.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.6.0",
"version": "0.8.2",
"title": "HO",
"description": "A head on situation with one target ship.",
"ownShip": {
Expand Down Expand Up @@ -28,7 +28,7 @@
}
],
"static": {
"id": 0,
"id": 1,
"mmsi": 257847600,
"name": "BASTO VI",
"dimensions": {
Expand Down Expand Up @@ -70,16 +70,16 @@
}
],
"static": {
"id": 10,
"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
"length": 178.0,
"width": 30.0,
"height": 30.0,
"a": 89.0,
"b": 89.0,
"c": 15.0,
"d": 15.0
},
"shipType": "Passenger"
}
Expand Down
6 changes: 3 additions & 3 deletions data/baseline_situations_generated/traffic_situation_02.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.6.0",
"version": "0.8.2",
"title": "CR-GW",
"description": "A crossing situation with one target ship. Own ship is give-way.",
"ownShip": {
Expand Down Expand Up @@ -28,7 +28,7 @@
}
],
"static": {
"id": 0,
"id": 1,
"mmsi": 257847600,
"name": "BASTO VI",
"dimensions": {
Expand Down Expand Up @@ -70,7 +70,7 @@
}
],
"static": {
"id": 10,
"id": 2,
"name": "target_ship_1",
"dimensions": {
"length": 122.0,
Expand Down
6 changes: 3 additions & 3 deletions data/baseline_situations_generated/traffic_situation_03.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.6.0",
"version": "0.8.2",
"title": "CR-SO",
"description": "A crossing situation with one target ship. Own ship is stand-on.",
"ownShip": {
Expand Down Expand Up @@ -28,7 +28,7 @@
}
],
"static": {
"id": 0,
"id": 1,
"mmsi": 257847600,
"name": "BASTO VI",
"dimensions": {
Expand Down Expand Up @@ -70,7 +70,7 @@
}
],
"static": {
"id": 10,
"id": 2,
"name": "target_ship_1",
"dimensions": {
"length": 50.0,
Expand Down
20 changes: 10 additions & 10 deletions data/baseline_situations_generated/traffic_situation_04.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.6.0",
"version": "0.8.2",
"title": "OT-GW",
"description": "A overting situation with one target ship. Own ship is give-way.",
"ownShip": {
Expand Down Expand Up @@ -28,7 +28,7 @@
}
],
"static": {
"id": 0,
"id": 1,
"mmsi": 257847600,
"name": "BASTO VI",
"dimensions": {
Expand Down Expand Up @@ -70,16 +70,16 @@
}
],
"static": {
"id": 10,
"id": 2,
"name": "target_ship_1",
"dimensions": {
"length": 178.0,
"width": 30.0,
"height": 30.0,
"a": 89.0,
"b": 89.0,
"c": 15.0,
"d": 15.0
"length": 122.0,
"width": 20.0,
"height": 8.0,
"a": 61.0,
"b": 61.0,
"c": 10.0,
"d": 10.0
},
"shipType": "Passenger"
}
Expand Down
38 changes: 19 additions & 19 deletions data/baseline_situations_generated/traffic_situation_05.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.6.0",
"version": "0.8.2",
"title": "OT-SO",
"description": "A overtaking situation with one target ship. Own ship is stand-on.",
"ownShip": {
Expand Down Expand Up @@ -28,7 +28,7 @@
}
],
"static": {
"id": 0,
"id": 1,
"mmsi": 257847600,
"name": "BASTO VI",
"dimensions": {
Expand All @@ -47,41 +47,41 @@
{
"initial": {
"position": {
"lon": 10.47731353,
"lat": 58.73759413
"lon": 10.47473875,
"lat": 58.73258475
},
"sog": 15.0,
"cog": 5.04,
"heading": 5.04,
"sog": 15.9,
"cog": 5.67,
"heading": 5.67,
"navStatus": "Under way using engine"
},
"waypoints": [
{
"position": {
"lon": 10.47731353,
"lat": 58.73759413
"lon": 10.47473875,
"lat": 58.73258475
}
},
{
"position": {
"lon": 10.4983629,
"lat": 58.86153921
"lon": 10.49994834,
"lat": 58.86444213
}
}
],
"static": {
"id": 10,
"id": 2,
"name": "target_ship_1",
"dimensions": {
"length": 50.0,
"width": 10.0,
"length": 122.0,
"width": 20.0,
"height": 8.0,
"a": 25.0,
"b": 25.0,
"c": 5.0,
"d": 5.0
"a": 61.0,
"b": 61.0,
"c": 10.0,
"d": 10.0
},
"shipType": "Cargo"
"shipType": "Passenger"
}
}
]
Expand Down
38 changes: 19 additions & 19 deletions data/baseline_situations_generated/traffic_situation_06.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.6.0",
"version": "0.8.2",
"title": "HO, HO",
"description": "Head-on situations with two target ships.",
"ownShip": {
Expand Down Expand Up @@ -28,7 +28,7 @@
}
],
"static": {
"id": 0,
"id": 1,
"mmsi": 257847600,
"name": "BASTO VI",
"dimensions": {
Expand Down Expand Up @@ -70,18 +70,18 @@
}
],
"static": {
"id": 10,
"id": 2,
"name": "target_ship_1",
"dimensions": {
"length": 50.0,
"width": 10.0,
"height": 8.0,
"a": 25.0,
"b": 25.0,
"c": 5.0,
"d": 5.0
"length": 178.0,
"width": 30.0,
"height": 30.0,
"a": 89.0,
"b": 89.0,
"c": 15.0,
"d": 15.0
},
"shipType": "Cargo"
"shipType": "Passenger"
}
},
{
Expand Down Expand Up @@ -110,16 +110,16 @@
}
],
"static": {
"id": 10,
"id": 3,
"name": "target_ship_2",
"dimensions": {
"length": 178.0,
"width": 30.0,
"height": 30.0,
"a": 89.0,
"b": 89.0,
"c": 15.0,
"d": 15.0
"length": 122.0,
"width": 20.0,
"height": 8.0,
"a": 61.0,
"b": 61.0,
"c": 10.0,
"d": 10.0
},
"shipType": "Passenger"
}
Expand Down
22 changes: 11 additions & 11 deletions data/baseline_situations_generated/traffic_situation_07.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.6.0",
"version": "0.8.2",
"title": "HO, CR-GW",
"description": "A head-on and crossing give-way situation with two target ships.",
"ownShip": {
Expand Down Expand Up @@ -28,7 +28,7 @@
}
],
"static": {
"id": 0,
"id": 1,
"mmsi": 257847600,
"name": "BASTO VI",
"dimensions": {
Expand Down Expand Up @@ -70,18 +70,18 @@
}
],
"static": {
"id": 10,
"id": 2,
"name": "target_ship_1",
"dimensions": {
"length": 122.0,
"width": 20.0,
"length": 50.0,
"width": 10.0,
"height": 8.0,
"a": 61.0,
"b": 61.0,
"c": 10.0,
"d": 10.0
"a": 25.0,
"b": 25.0,
"c": 5.0,
"d": 5.0
},
"shipType": "Passenger"
"shipType": "Cargo"
}
},
{
Expand Down Expand Up @@ -110,7 +110,7 @@
}
],
"static": {
"id": 10,
"id": 3,
"name": "target_ship_2",
"dimensions": {
"length": 178.0,
Expand Down
Loading
Loading