Skip to content
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

Jump to bottom

Maritime tutorials 💧 - Part 4 of 4 #2260

Merged
merged 68 commits into from
Dec 23, 2023
Merged

Maritime tutorials 💧 - Part 4 of 4 #2260

merged 68 commits into from
Dec 23, 2023

Conversation

caguero
Copy link
Contributor

@caguero caguero commented Dec 6, 2023

Summary

This pull request finishes the series of maritime tutorials. I'm adding a new tutorial covering how to create a maritime surface vehicle.

Screenshot from 2023-12-06 21-11-01

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.

caguero and others added 30 commits December 1, 2023 19:08
@caguero
Adding maritime tutorials.
08a93c3 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Adding \page
9f07e8a
@caguero
Buoyancy and hydrodynamics tutorials.
df4034f 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/adding_system_plugins.md
7aac66f 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/adding_system_plugins.md
85ef1d1 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/adding_system_plugins.md
edfc7b5 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/adding_system_plugins.md
5720567 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/adding_system_plugins.md
299c181 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/create_vehicle.md
a0d3d6a 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/create_vehicle.md
20da621 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/create_vehicle.md
4c3d0cd 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/frame_reference.md
fe3bcd4 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/frame_reference.md
ce7df55 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @crvogt
Apply suggestions from code review
a00ea7d 
Co-authored-by: crvogt <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @crvogt
Update tutorials/adding_visuals.md
f0da870 
Co-authored-by: crvogt <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Merge branch 'caguero/maritime_tutorials_part1' into caguero/maritime…
61503a8 
…_tutorials_part2
@caguero
Lander and lrauv tutorials.
5213800 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Tweak
5665677 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Tweaks
d3b3970 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Merge branch 'caguero/maritime_tutorials_part1' into caguero/maritime…
766f3b3 
…_tutorials_part2
@caguero @ahcorde
Update tutorials/theory_buoyancy.md
ded077d 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_buoyancy.md
6aaa9f2 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_buoyancy.md
d05b43d 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_buoyancy.md
e22a5ab 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_buoyancy.md
d6f3757 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_hydrodynamics.md
c8fe299 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_hydrodynamics.md
f8f5678 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_hydrodynamics.md
18c8fb3 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_hydrodynamics.md
52fa02d 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @ahcorde
Update tutorials/theory_hydrodynamics.md
412bce2 
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
caguero and others added 11 commits December 12, 2023 11:08
@caguero @crvogt
Update tutorials/theory_hydrodynamics.md
45f5e2b 
Co-authored-by: crvogt <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @crvogt
Update tutorials/lander.md
397477a 
Co-authored-by: crvogt <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @crvogt
Update tutorials/lander.md
236559a 
Co-authored-by: crvogt <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @crvogt
Update tutorials/lander.md
ca65fb9 
Co-authored-by: crvogt <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @crvogt
Update tutorials/surface_vehicles.md
755e3d0 
Co-authored-by: crvogt <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero @crvogt
Update tutorials/surface_vehicles.md
cd10951 
Co-authored-by: crvogt <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Note about added mass.
2c69504 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Merge branch 'caguero/maritime_tutorials_part2' of github.com:gazebos…
6b27aba 
…im/gz-sim into caguero/maritime_tutorials_part2
@caguero
Merge branch 'caguero/maritime_tutorials_part2' into caguero/maritime…
a2a8334 
…_tutorials_part3
@caguero
Merge branch 'caguero/maritime_tutorials_part3' into caguero/maritime…
b114462 
…_tutorials_part4
@caguero
Tweaks
292e12d 
Signed-off-by: Carlos Agüero <[email protected]>
crvogt
crvogt approved these changes Dec 21, 2023
View reviewed changes
Copy link
Contributor

@crvogt crvogt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No more changes requested from me, looks good.

ahcorde
ahcorde requested changes Dec 22, 2023
View reviewed changes
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/CMakeLists.txt Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/CMakeLists.txt Outdated Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/CMakeLists.txt Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/CMakeLists.txt Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/src/PublisherPlugin.hh Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/src/WaveVisual.hh Outdated Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/src/Wavefield.cc Outdated Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/src/Wavefield.cc Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/src/Wavefield.hh Show resolved Hide resolved
tutorials/files/surface_vehicles/gazebo_maritime_ws/src/gazebo_maritime/src/Wavefield.hh Outdated Show resolved Hide resolved
Base automatically changed from caguero/maritime_tutorials_part3 to gz-sim8 December 22, 2023 17:10
@caguero
Merge
8ceffd3 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Tweaks
b6214af 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Remove
d29db6e 
Signed-off-by: Carlos Agüero <[email protected]>
ahcorde
ahcorde requested changes Dec 22, 2023
View reviewed changes
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wait some linters are failing https://github.com/gazebosim/gz-sim/actions/runs/7302639519/job/19901655075?pr=2260

@caguero
Style.
92eeb8c 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Style
70d7799 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Style
33ba83e 
Signed-off-by: Carlos Agüero <[email protected]>
@caguero
Copy link
Contributor Author

caguero commented Dec 22, 2023

wait some linters are failing https://github.com/gazebosim/gz-sim/actions/runs/7302639519/job/19901655075?pr=2260

It should be fixed now.

@codecov Codecov
Copy link

codecov bot commented Dec 22, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8b40b54) 65.62% compared to head (33ba83e) 65.63%.
Report is 4 commits behind head on gz-sim8.

Additional details and impacted files 
@@             Coverage Diff             @@
##           gz-sim8    #2260      +/-   ##
===========================================
+ Coverage    65.62%   65.63%   +0.01%     
===========================================
  Files          324      324              
  Lines        30924    30925       +1     
===========================================
+ Hits         20293    20298       +5     
+ Misses       10631    10627       -4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@caguero caguero merged commit 8f84b05 into gz-sim8 Dec 23, 2023
8 of 10 checks passed
@caguero caguero deleted the caguero/maritime_tutorials_part4 branch December 23, 2023 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crvogt crvogt crvogt approved these changes

@ahcorde ahcorde ahcorde approved these changes

@mabelzhang mabelzhang Awaiting requested review from mabelzhang mabelzhang is a code owner

@mjcarroll mjcarroll Awaiting requested review from mjcarroll mjcarroll is a code owner

Assignees
No one assigned
Labels
None yet
Projects
Core development
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@caguero @ahcorde @crvogt