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

Added tutorial for Automatic Inertia Calculator #2119

Merged
merged 17 commits into from
Sep 20, 2023
Merged

Added tutorial for Automatic Inertia Calculator #2119

merged 17 commits into from
Sep 20, 2023

Conversation

jasmeet0915
Copy link
Contributor

@jasmeet0915 jasmeet0915 commented Sep 5, 2023 •
edited
Loading

🎉 New feature

This PR adds tutorials for the Automatic Inertia Calculation feature.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • 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.

@jasmeet0915
Added empty tutorial file
c28afc7 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Update and rename auto_inertia.md to auto_inertia_calculation.md
594ee52 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Added example world with pendulum demo
102a22d 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Added demo .gifs
37b63a7 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Added auto inertia rolling shapes demo
c10c05f 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Updated auto_inertia.md tutorial
44a6b54 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Update tutorials.md.in to include auto_inertia page
0386738 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Sep 5, 2023
ahcorde
ahcorde requested changes Sep 5, 2023
View reviewed changes
examples/worlds/auto_inertia_rolling_shapes.sdf Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
@jasmeet0915
Reduced number of characters in one line
35df259 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Update auto_inertia_rolling_shapes.sdf example to use auto inertial i…
8ed75d7 
…n all shaoes

Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915 jasmeet0915 force-pushed the jasmeet/auto_inertia_tutorial branch from 1252dcf to b23a5d2 Compare September 6, 2023 07:03
@jasmeet0915
Added newline at end of file
bdf80ba 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915 jasmeet0915 force-pushed the jasmeet/auto_inertia_tutorial branch from b23a5d2 to bdf80ba Compare September 6, 2023 07:05
@jasmeet0915
Trimmed trailing whitespaces
8fc7634 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@codecov
Copy link

codecov bot commented Sep 6, 2023 •
edited
Loading

Codecov Report

Merging #2119 (091f8f9) into gz-sim8 (58a0c0b) will increase coverage by 0.01%.
Report is 26 commits behind head on gz-sim8.
The diff coverage is 80.00%.

❗ Current head 091f8f9 differs from pull request most recent head 1f74cb9. Consider uploading reports for the commit 1f74cb9 to get more accurate results

@@             Coverage Diff             @@
##           gz-sim8    #2119      +/-   ##
===========================================
+ Coverage    65.45%   65.47%   +0.01%     
===========================================
  Files          323      323              
  Lines        30699    30708       +9     
===========================================
+ Hits         20094    20106      +12     
+ Misses       10605    10602       -3
Files Changed Coverage Δ
src/SimulationRunner.cc 91.73% <50.00%> (+0.52%) ⬆️
src/systems/sensors/Sensors.cc 63.56% <100.00%> (+0.38%) ⬆️
src/systems/user_commands/UserCommands.cc 60.80% <100.00%> (ø)

quarkytale
quarkytale reviewed Sep 13, 2023
View reviewed changes
Copy link
Contributor

@quarkytale quarkytale left a comment

Choose a reason for hiding this comment

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

Thanks for compiling this! Just a few rephrases and formatting, looks great otherwise.

tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
@jasmeet0915
Minor rephrasing and formatting changes
2b8be4c 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
azeey
azeey requested changes Sep 13, 2023
View reviewed changes
Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

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

Looks great! I have mostly minor issues and some clarifications I'd like to see.

tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Show resolved Hide resolved
examples/worlds/auto_inertia_rolling_shapes.sdf Outdated Show resolved Hide resolved
tutorials/auto_inertia_calculation.md Show resolved Hide resolved
@azeey azeey added beta Targeting beta release of upcoming collection documentation Improvements or additions to documentation labels Sep 13, 2023
@jasmeet0915
Corrected density tag
07bd6cd 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Corrected formatting, update documentation
6217798 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Trimmed trailing whitespaces
822f1c0 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Corrected auto_inertia_rolling_shapes world name
52ffa22 
Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
azeey
azeey approved these changes Sep 19, 2023
View reviewed changes
Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

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

Other than the issue with submeshes that needs to be documented, this LGTM!

@azeey azeey requested a review from ahcorde September 19, 2023 17:58
@jasmeet0915
Documented the limitation of using meshes having submeshes with autom…
1f74cb9 
…atic computation

Signed-off-by: Jasmeet Singh <jasmeet0915@gmail.com>
@jasmeet0915
Copy link
Contributor Author

@azeey I have documented the limitation with using submeshes in 1f74cb9

@azeey azeey merged commit 4d4b680 into gazebosim:gz-sim8 Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@quarkytale quarkytale quarkytale left review comments

@ahcorde ahcorde ahcorde approved these changes

@azeey azeey azeey 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
beta Targeting beta release of upcoming collection documentation Improvements or additions to documentation 🎵 harmonic Gazebo Harmonic
Projects
Core development
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jasmeet0915 @azeey @ahcorde @quarkytale