Maritime tutorials 💧 - Part 2 of 4 #2258

caguero · 2023-12-02T16:22:51Z

Summary

This pull request continues the series of maritime tutorials. I'm adding two new tutorials covering the theory of operation of the buoyancy and hydrodynamics plugins.

Pinging @crvogt for review.

How to test it

colcon build --merge-install --packages-select gz-sim8 --cmake-target doc

Point your browser to build/gz-sim8/doxygen/html/tutorials.html and go from there.

Checklist

Signed all commits for DCO
Added tests
Updated documentation (as needed)
Updated migration guide (as needed)
Consider updating Python bindings (if the library has them)
codecheck passed (See contributing)
All tests passed (See test coverage)
While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

Signed-off-by: Carlos Agüero <[email protected]>

tutorials/theory_buoyancy.md

tutorials/theory_hydrodynamics.md

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Co-authored-by: crvogt <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

…_tutorials_part2

Signed-off-by: Carlos Agüero <[email protected]>

…_tutorials_part2

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Signed-off-by: Carlos Agüero <[email protected]>

tutorials/theory_buoyancy.md

Co-authored-by: Ian Chen <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Signed-off-by: Carlos Agüero <[email protected]>

…im/gz-sim into caguero/maritime_tutorials_part1

…_tutorials_part2

Co-authored-by: Ian Chen <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

…im/gz-sim into caguero/maritime_tutorials_part2

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

arjo129

I absolutely enjoyed reading the theory tutorial. :) Just would like to add a small note at the end of the buoyancy tutorial regarding collision meshes.

arjo129 · 2023-12-11T03:19:10Z

tutorials/theory_buoyancy.md

+# Known limitations
+
+When the buoyancy plugin is configured in `graded buoyancy mode`, only `<box>`
+and `<sphere>` collision geometries are supported.


Also add a note that it relies on collision meshes. This can be annoying for end users who want to accurately model collision and buoyancy but the two have two different types of behaviour.

Is your suggestion captured in these paragraphs?

https://github.com/gazebosim/gz-sim/pull/2258/files#diff-378e68a808fda7960b03c7a17b40fd5945fb274e584ed96850c3dac10d6bd4cbR16-R30

tutorials/theory_hydrodynamics.md

Co-authored-by: crvogt <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Signed-off-by: Carlos Agüero <[email protected]>

…im/gz-sim into caguero/maritime_tutorials_part2

crvogt

This looks good to me.

ahcorde

Comment related with one link, otherwise LGTM

tutorials/theory_buoyancy.md

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Signed-off-by: Carlos Agüero <[email protected]>

caguero added 3 commits December 1, 2023 19:08

Adding maritime tutorials.

08a93c3

Signed-off-by: Carlos Agüero <[email protected]>

Adding \page

9f07e8a

Buoyancy and hydrodynamics tutorials.

df4034f

Signed-off-by: Carlos Agüero <[email protected]>

caguero requested review from mabelzhang and mjcarroll as code owners December 2, 2023 16:22

ahcorde requested changes Dec 4, 2023

View reviewed changes

caguero and others added 13 commits December 5, 2023 10:26

Update tutorials/adding_system_plugins.md

7aac66f

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/adding_system_plugins.md

85ef1d1

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/adding_system_plugins.md

edfc7b5

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/adding_system_plugins.md

5720567

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/adding_system_plugins.md

299c181

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/create_vehicle.md

a0d3d6a

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/create_vehicle.md

20da621

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/create_vehicle.md

4c3d0cd

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/frame_reference.md

fe3bcd4

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/frame_reference.md

ce7df55

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Apply suggestions from code review

a00ea7d

Co-authored-by: crvogt <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/adding_visuals.md

f0da870

Co-authored-by: crvogt <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Merge branch 'caguero/maritime_tutorials_part1' into caguero/maritime…

61503a8

…_tutorials_part2

caguero changed the title ~~Maritime tutorials - Part 2~~ Maritime tutorials - Part 2 of 4 Dec 5, 2023

caguero and others added 10 commits December 5, 2023 22:06

Tweaks

d3b3970

Signed-off-by: Carlos Agüero <[email protected]>

Merge branch 'caguero/maritime_tutorials_part1' into caguero/maritime…

766f3b3

…_tutorials_part2

Update tutorials/theory_buoyancy.md

ded077d

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_buoyancy.md

6aaa9f2

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_buoyancy.md

d05b43d

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_buoyancy.md

e22a5ab

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_buoyancy.md

d6f3757

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_hydrodynamics.md

c8fe299

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_hydrodynamics.md

f8f5678

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_hydrodynamics.md

18c8fb3

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

caguero and others added 3 commits December 5, 2023 22:09

Update tutorials/theory_hydrodynamics.md

52fa02d

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_hydrodynamics.md

412bce2

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Tweak

d4c5b70

Signed-off-by: Carlos Agüero <[email protected]>

iche033 reviewed Dec 6, 2023

View reviewed changes

tutorials/theory_buoyancy.md Outdated Show resolved Hide resolved

tutorials/theory_buoyancy.md Outdated Show resolved Hide resolved

tutorials/theory_buoyancy.md Outdated Show resolved Hide resolved

caguero and others added 11 commits December 6, 2023 14:15

Update tutorials/create_vehicle.md

8ba76b1

Co-authored-by: Ian Chen <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/adding_visuals.md

ff1e127

Co-authored-by: Ian Chen <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Tweaks

ef9be7b

Signed-off-by: Carlos Agüero <[email protected]>

Merge branch 'caguero/maritime_tutorials_part1' of github.com:gazebos…

6153ae0

…im/gz-sim into caguero/maritime_tutorials_part1

Merge branch 'caguero/maritime_tutorials_part1' into caguero/maritime…

e4722f4

…_tutorials_part2

Update tutorials/theory_buoyancy.md

592eec7

Co-authored-by: Ian Chen <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_buoyancy.md

6dd4668

Co-authored-by: Ian Chen <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_buoyancy.md

6b250d9

Co-authored-by: Ian Chen <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Merge branch 'caguero/maritime_tutorials_part2' of github.com:gazebos…

37e09cf

…im/gz-sim into caguero/maritime_tutorials_part2

Apply suggestions from code review

1b4be86

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Update tutorials/theory_buoyancy.md

9ec2750

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

caguero changed the title ~~Maritime tutorials - Part 2 of 4~~ Maritime tutorials 💧 - Part 2 of 4 Dec 7, 2023

arjo129 reviewed Dec 11, 2023

View reviewed changes

crvogt reviewed Dec 12, 2023

View reviewed changes

tutorials/theory_hydrodynamics.md Outdated Show resolved Hide resolved

caguero and others added 3 commits December 12, 2023 11:08

Update tutorials/theory_hydrodynamics.md

45f5e2b

Co-authored-by: crvogt <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Note about added mass.

2c69504

Signed-off-by: Carlos Agüero <[email protected]>

Merge branch 'caguero/maritime_tutorials_part2' of github.com:gazebos…

6b27aba

…im/gz-sim into caguero/maritime_tutorials_part2

crvogt approved these changes Dec 21, 2023

View reviewed changes

caguero requested a review from ahcorde December 22, 2023 09:34

ahcorde approved these changes Dec 22, 2023

View reviewed changes

tutorials/theory_buoyancy.md Outdated Show resolved Hide resolved

Update tutorials/theory_buoyancy.md

ae6a600

Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Carlos Agüero <[email protected]>

Base automatically changed from caguero/maritime_tutorials_part1 to gz-sim8 December 22, 2023 16:58

Merge

cbc49fa

Signed-off-by: Carlos Agüero <[email protected]>

caguero merged commit ae0070f into gz-sim8 Dec 22, 2023
3 of 8 checks passed

caguero deleted the caguero/maritime_tutorials_part2 branch December 22, 2023 17:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Maritime tutorials 💧 - Part 2 of 4 #2258

Maritime tutorials 💧 - Part 2 of 4 #2258

caguero commented Dec 2, 2023

arjo129 left a comment

arjo129 Dec 11, 2023

caguero Dec 14, 2023 •

edited

Loading

crvogt left a comment

ahcorde left a comment

Maritime tutorials 💧 - Part 2 of 4 #2258

Maritime tutorials 💧 - Part 2 of 4 #2258

Conversation

caguero commented Dec 2, 2023

Summary

How to test it

Checklist

arjo129 left a comment

Choose a reason for hiding this comment

arjo129 Dec 11, 2023

Choose a reason for hiding this comment

caguero Dec 14, 2023 • edited Loading

Choose a reason for hiding this comment

crvogt left a comment

Choose a reason for hiding this comment

ahcorde left a comment

Choose a reason for hiding this comment

caguero Dec 14, 2023 •

edited

Loading