How borisimo/tmr4240_group_12 works
This repository is a teaching simulator for designing and evaluating a 3-DOF dynamic-positioning system for R/V Gunnerus. The main workflow is to configure and run a Part 1 or Part 2 scenario: the simulation engine advances the vessel, obtains control and environmental loads, allocates thrust, and records results for plotting. Part 2 adds measured-pose feedback with observer estimates, constrained actuators, irregular-wave loads, and thrust-utilisation analysis. The README documents these capabilities; source excerpts show key Part 1 wiring and selected model behavior, while some Part 2 connections are supported by the source index or README rather than inspected implementation excerpts.
Main entry points: simulation_part_2.py Part 2 loop · simulation_part_1.py Part 1 loop · run_case_part_2.py Part 2 runner · thruster_dynamics.py Thruster dynamics
Components 29
Scenario design
- Part 1 runner
run_case_part1.py - Part 2 runner
run_case_part_2.py
Part 1 design
- DP controller
part_1/controller.py - Current model
part_1/current.py - Wind model
part_1/wind.py - Reference model
part_1/reference.py - Thrust allocation
part_1/thrust_allocation.py - Part 1 config
part_1/config.py
Part 2 design
- Thrust metrics
part_2/utilization.py - DP controller
part_2/controller.py - Current model
part_2/current.py - Wind model
part_2/wind.py - Reference model
part_2/reference.py - Thrust allocation
part_2/thrust_allocation.py - State observers
part_2/observer.py - Part 2 config
part_2/config.py
Simulation runtime
- Part 1 loop
simulation/simulation_part_1.py - Part 2 loop
simulation/simulation_part_2.py - Open-loop plant
simulation/plant.py - Shared plotting
simulation/plotter.py - Part 2 plotting
simulation/plotter_part_2.py - Capability sweep
simulation/capability.py
Vessel and environment
- Gunnerus model
models/gunnerus_3dof.py - Thruster dynamics
models/thruster_dynamics.py - Pose sensors
models/sensors.py - Wave loads
models/waves.py - Vessel wave data
data/gunnerus_vessel.json - Wind coefficients
data/wind_coeff.csv
Other components
- Engineer
Connections 33
- Engineer → Part 1 runner: configures
README.md - Engineer → Part 2 runner: configures
README.md - Part 1 runner → Part 1 loop: runs
run_case_part1.py - Part 2 runner → Part 2 loop: runs
run_case_part_2.py - Part 1 runner → Shared plotting: plots results
run_case_part1.py - Part 2 runner → Part 2 plotting: plots results
run_case_part_2.py - Part 2 runner → Capability sweep: runs sweep
run_case_part_2.py - Part 1 loop → Gunnerus model: advances
simulation/simulation_part_1.py - Part 1 loop → Thruster dynamics: steps actuators
simulation/simulation_part_1.py - Part 1 loop → DP controller: requests wrench
simulation/simulation_part_1.py - Part 1 loop → Reference model: updates reference
simulation/simulation_part_1.py - Part 1 loop → Thrust allocation: allocates thrust
simulation/simulation_part_1.py - Part 1 loop → Current model: reads current
simulation/simulation_part_1.py - Part 1 loop → Wind model: reads wind loads
simulation/simulation_part_1.py - Part 2 loop → Open-loop plant: uses plant
simulation/simulation_part_2.py - Part 2 loop → Gunnerus model: advances
simulation/simulation_part_2.py - Part 2 loop → Thruster dynamics: steps actuators
simulation/simulation_part_2.py - Part 2 loop → Pose sensors: measures pose
simulation/simulation_part_2.py - Part 2 loop → State observers: estimates state
simulation/simulation_part_2.py - Part 2 loop → DP controller: requests wrench
simulation/simulation_part_2.py - Part 2 loop → Reference model: updates reference
simulation/simulation_part_2.py - Part 2 loop → Thrust allocation: allocates thrust
simulation/simulation_part_2.py - Part 2 loop → Current model: reads current
simulation/simulation_part_2.py - Part 2 loop → Wind model: reads wind loads
simulation/simulation_part_2.py - Part 2 loop → Wave loads: gets wave loads
README.md - Wave loads → Vessel wave data: loads data
README.md - Wind model → Wind coefficients: loads coefficients
part_1/wind.py - Thrust allocation → Thruster dynamics: uses limits
part_1/thrust_allocation.py - Thrust allocation → Thruster dynamics: uses limits
part_2/thrust_allocation.py - DP controller → Part 1 config: uses gains
part_1/controller.py - DP controller → Part 1 config: uses gains
part_2/controller.py - Capability sweep → Thrust metrics: computes metrics
simulation/capability.py - Part 2 plotting → Part 2 loop: plots logs