deploy: e4ba848

dnv-opensource · Jan 30, 2025 · 3021af1 · 3021af1
commit 3021af1
Show file tree

Hide file tree

Showing 125 changed files with 25,822 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b173307822a54cfbe21556b56523e84d
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/CHANGELOG.html b/CHANGELOG.html
diff --git a/LICENSE.html b/LICENSE.html
diff --git a/README.html b/README.html
diff --git a/STYLEGUIDE.html b/STYLEGUIDE.html
diff --git a/_autosummary/trafficgen.check_land_crossing.html b/_autosummary/trafficgen.check_land_crossing.html
diff --git a/_autosummary/trafficgen.encounter.html b/_autosummary/trafficgen.encounter.html
diff --git a/_autosummary/trafficgen.marine_system_simulator.html b/_autosummary/trafficgen.marine_system_simulator.html
diff --git a/_autosummary/trafficgen.plot_traffic_situation.html b/_autosummary/trafficgen.plot_traffic_situation.html
diff --git a/_autosummary/trafficgen.read_files.html b/_autosummary/trafficgen.read_files.html
diff --git a/_autosummary/trafficgen.ship_traffic_generator.html b/_autosummary/trafficgen.ship_traffic_generator.html
diff --git a/_autosummary/trafficgen.utils.html b/_autosummary/trafficgen.utils.html
diff --git a/_autosummary/trafficgen.write_traffic_situation_to_file.html b/_autosummary/trafficgen.write_traffic_situation_to_file.html
diff --git a/_sources/CHANGELOG.md.txt b/_sources/CHANGELOG.md.txt
@@ -0,0 +1,2 @@
+```{include} ../../CHANGELOG.md
+```
diff --git a/_sources/LICENSE.md.txt b/_sources/LICENSE.md.txt
@@ -0,0 +1,3 @@
+# LICENSE
+```{include} ../../LICENSE
+```
diff --git a/_sources/README.md.txt b/_sources/README.md.txt
@@ -0,0 +1,2 @@
+```{include} ../../README.md
+```
diff --git a/_sources/STYLEGUIDE.md.txt b/_sources/STYLEGUIDE.md.txt
@@ -0,0 +1,2 @@
+```{include} ../../STYLEGUIDE.md
+```
diff --git a/_sources/_autosummary/trafficgen.check_land_crossing.rst.txt b/_sources/_autosummary/trafficgen.check_land_crossing.rst.txt
@@ -0,0 +1,13 @@
+trafficgen.check\_land\_crossing
+================================
+
+.. automodule:: trafficgen.check_land_crossing
+   :members:
+
+
+
+   .. rubric:: Functions
+   .. autosummary::
+
+      path_crosses_land
+
diff --git a/_sources/_autosummary/trafficgen.encounter.rst.txt b/_sources/_autosummary/trafficgen.encounter.rst.txt
@@ -0,0 +1,26 @@
+trafficgen.encounter
+====================
+
+.. automodule:: trafficgen.encounter
+   :members:
+
+
+
+   .. rubric:: Functions
+   .. autosummary::
+
+      assign_beta
+      assign_beta_from_list
+      assign_future_position_to_target_ship
+      assign_sog_to_target_ship
+      assign_vector_time
+      calculate_min_vector_length_target_ship
+      calculate_relative_bearing
+      calculate_ship_cog
+      check_encounter_evolvement
+      decide_target_ship
+      define_own_ship
+      determine_colreg
+      find_start_position_target_ship
+      generate_encounter
+
diff --git a/_sources/_autosummary/trafficgen.marine_system_simulator.rst.txt b/_sources/_autosummary/trafficgen.marine_system_simulator.rst.txt
@@ -0,0 +1,15 @@
+trafficgen.marine\_system\_simulator
+====================================
+
+.. automodule:: trafficgen.marine_system_simulator
+   :members:
+
+
+
+   .. rubric:: Functions
+   .. autosummary::
+
+      flat2llh
+      llh2flat
+      ssa
+
diff --git a/_sources/_autosummary/trafficgen.plot_traffic_situation.rst.txt b/_sources/_autosummary/trafficgen.plot_traffic_situation.rst.txt
@@ -0,0 +1,19 @@
+trafficgen.plot\_traffic\_situation
+===================================
+
+.. automodule:: trafficgen.plot_traffic_situation
+   :members:
+
+
+
+   .. rubric:: Functions
+   .. autosummary::
+
+      add_ship_to_map
+      add_ship_to_plot
+      calculate_ship_outline
+      calculate_vector_arrow
+      find_max_value_for_plot
+      plot_specific_traffic_situation
+      plot_traffic_situations
+
diff --git a/_sources/_autosummary/trafficgen.read_files.rst.txt b/_sources/_autosummary/trafficgen.read_files.rst.txt
@@ -0,0 +1,25 @@
+trafficgen.read\_files
+======================
+
+.. automodule:: trafficgen.read_files
+   :members:
+
+
+
+   .. rubric:: Functions
+   .. autosummary::
+
+      camel_to_snake
+      convert_encounters
+      convert_keys_to_snake_case
+      convert_own_ship_initial_data
+      convert_own_ship_waypoints
+      convert_settings_data_from_maritime_to_si_units
+      convert_ship_data_from_maritime_to_si_units
+      convert_situation_data_from_maritime_to_si_units
+      read_encounter_settings_file
+      read_generated_situation_files
+      read_own_ship_static_file
+      read_situation_files
+      read_target_ship_static_files
+
diff --git a/_sources/_autosummary/trafficgen.ship_traffic_generator.rst.txt b/_sources/_autosummary/trafficgen.ship_traffic_generator.rst.txt
@@ -0,0 +1,13 @@
+trafficgen.ship\_traffic\_generator
+===================================
+
+.. automodule:: trafficgen.ship_traffic_generator
+   :members:
+
+
+
+   .. rubric:: Functions
+   .. autosummary::
+
+      generate_traffic_situations
+
diff --git a/_sources/_autosummary/trafficgen.utils.rst.txt b/_sources/_autosummary/trafficgen.utils.rst.txt
@@ -0,0 +1,26 @@
+trafficgen.utils
+================
+
+.. automodule:: trafficgen.utils
+   :members:
+
+
+
+   .. rubric:: Functions
+   .. autosummary::
+
+      calculate_bearing_between_waypoints
+      calculate_destination_along_track
+      calculate_distance
+      calculate_position_along_track_using_waypoints
+      calculate_position_at_certain_time
+      convert_angle_0_to_2_pi_to_minus_pi_to_pi
+      convert_angle_minus_pi_to_pi_to_0_to_2_pi
+      deg_2_rad
+      knot_2_m_pr_s
+      m_2_nm
+      m_pr_s_2_knot
+      min_2_s
+      nm_2_m
+      rad_2_deg
+
diff --git a/_sources/_autosummary/trafficgen.write_traffic_situation_to_file.rst.txt b/_sources/_autosummary/trafficgen.write_traffic_situation_to_file.rst.txt
@@ -0,0 +1,15 @@
+trafficgen.write\_traffic\_situation\_to\_file
+==============================================
+
+.. automodule:: trafficgen.write_traffic_situation_to_file
+   :members:
+
+
+
+   .. rubric:: Functions
+   .. autosummary::
+
+      convert_ship_data_from_si_units_to_maritime
+      convert_situation_data_from_si_units_to__maritime
+      write_traffic_situations_to_json_file
+
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -0,0 +1,7 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   trafficgen
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,26 @@
+.. my-package documentation master file, created by
+   sphinx-quickstart on Wed Jul  6 21:16:21 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Ship Traffic Generator Documentation
+====================================
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+   README
+   usage
+   input_files
+   api
+   CHANGELOG
+   STYLEGUIDE
+   LICENSE
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`