Ship Traffic Generator Documentation

Contents:

• Traffic Generator
  • Installation
  • Usage
  • Development Setup
    • Install UV
    • Install Python
    • Clone the repository
    • Install dependencies
    • (Optional) Activate the virtual environment
    • Install the package
    • Test the install
    • Documentation
    • Contributing
    • Testing PRs
• Usage
  • Input situations
  • Baseline situations
  • Output situations
  • Plotting
    • Plotting all generated traffic situations
    • Individual plots with map background
  • Scaling encounters
• Input files
  • Situation files
  • Own ship file
  • Target ship files
  • Encounter settings
• Output files
• API Reference
  • trafficgen package
    • Modules
      • trafficgen.ship_traffic_generator
      • trafficgen.read_files
      • trafficgen.encounter
      • trafficgen.check_land_crossing
      • trafficgen.marine_system_simulator
      • trafficgen.plot_traffic_situation
      • trafficgen.write_traffic_situation_to_file
      • trafficgen.types
      • trafficgen.utils
• Application API
  • Available endpoints
  • Localhost TLS (HTTPS)
  • OpenAPI specification
• Changelog
  • [Unreleased]
    • Changed
  • [0.9.0] - 2026-04-16
    • Changed
    • Dependencies
  • [0.8.5] - 2026-02-20
    • Changed
  • [0.8.4] - 2025-11-26
    • Changed
  • [0.8.3] - 2025-10-31
    • Changed
  • [0.8.2] - 2025-10-03
    • Changed
  • [0.8.1] - 2025-05-12
    • Changed
  • [0.8.0] - 2025-05-09
    • Changed
  • [0.7.2] - 2025-03-14
    • Changed
  • [0.7.1] - 2025-01-30
    • Changed
  • [0.7.0] - 2025-01-22
    • Changed
  • 0.6.0 - 2024-11-11
    • Changed
  • 0.5.0 - 2024-04-26
    • Changed
  • 0.4.0 - 2024-04-19
    • Changed
  • 0.3.0 - 2024-04-10
    • Changed
  • 0.2.0 - 2024-01-11
    • Changed
  • [0.1.0] - 2023-11-08
• Style Guide
  • References
  • Code Layout
  • Line Breaks
  • String Formatting
  • Naming Conventions
  • Named Arguments
  • Commenting
  • Type hints
  • Docstrings
  • Exceptions
  • Imports
  • Unit-tests
  • And finally: It is a bad idea to use
• LICENSE

Indices and tables

• Index

• Module Index