Added tutorials in Harmonic #372

quarkytale · 2023-08-24T22:22:38Z

Added tutorials from docs/garden to docs/harmonic.

Unsure about Feature Comparison for Harmonic https://gazebosim.org/docs/garden/comparison, need advice on that.
Also about the target branch, should I be targeting master instead?

Signed-off-by: Dharini Dutia <[email protected]>

Signed-off-by: Mabel Zhang <[email protected]>

mabelzhang

Re feature comparison - there's an internal spreadsheet about Gazebo roadmap.
There's a public one for Harmonic here https://gazebosim.org/docs/garden/roadmap

I ran a diff against the garden folder.
I'm pushing a few diffs in 8f2fde6 that I found against the Garden pages that should be updated for Harmonic too.

These files are not yet in this PR so I'll just comment manually:

harmonic/install.md needs to be updated with the Ubuntu versions supported - currently says Focal and Jammy, should be Jammy and 24.04 I believe. Update: Pushed in 9143ed7
There's also a typo in garden/install.md, where it says "uses the Gazebo brand instead of Gazebo", the second Gazebo should be Ignition. That can be in a separate PR later.

harmonic/troubleshooting.md line 54 the dlopen error has both harmonic and libgz-physics6 in it... That looks like it's a find+replace thing from the Garden page. Maybe should just change it back to garden since harmonic is with physics7, and that error message shouldn't be fabricated manually.
Same for line 57.
I'll let you decide on this one.

harmonic/GUI_tutorial.md

mabelzhang · 2023-08-29T22:36:54Z

harmonic/index.yaml

@@ -32,3 +32,47 @@ pages:
      - name: troubleshooting
        title: Troubleshooting
        file: troubleshooting.md
+  - name: migration_from_ignition


I guess we don't have the binary install pages until after release? Or do we have binary install instructions with pre-release repos? Do we need them for the tutorial party? I guess I don't know when we usually add the binary install pages.

I wasn't sure of that too

@azeey says we use the pre-release repos for the tutorial party. So we should add all those 3 binary install pages.

E.g. https://github.com/gazebosim/docs/pull/310/files
Probably looking at the history of the Mac and Windows binary install files in Garden will tell you how to do the pre-release for those.
I'm out and about today and in meetings so I can't do this at the moment...

No worries, I can update that

Done in 1aeae34

harmonic/index.yaml

mabelzhang · 2023-08-29T23:28:16Z

We should definitely at least have the feature comparison.md page copied from Garden. It's not in index.yaml right now.
That's just Gazebo-classic to Gazebo comparison. Most of the entries will be the same, with the new things in the spreadsheet added for Harmonic.

Signed-off-by: Mabel Zhang <[email protected]>

mabelzhang · 2023-08-30T01:24:29Z

I pushed a feature comparison page in c557a9c with straight-forward items in the internal roadmap spreadsheet.

That is, Wide angle camera, DVL sensor, and Projector for Ogre 1.x.
Re Projector - we should probably create an issue ticket saying projector doesn't work well for Ogre 2 yet. For now, I just link to the original Projector PR.

These other released features I'm not sure whether / where to add to the page:

We need to add Python somewhere. The only thing existing on there about Python bindings is for SDF. Either in "Others" section or create a new section for it, for better visibility?
Infra to generate bindings for gz-msgs
List subscribers in CLI and also get their info
Compute moments of inertia for SDFormat links (Is this going to make it?)

@azeey to advise

Signed-off-by: Mabel Zhang <[email protected]>

mabelzhang · 2023-08-30T01:28:06Z

Pushed Ubuntu version in 9143ed7
@azeey to double check - Harmonic is Jammy and 24.04 right?

Co-authored-by: Mabel Zhang <[email protected]> Signed-off-by: Dharini Dutia <[email protected]>

Signed-off-by: Dharini Dutia <[email protected]>

quarkytale · 2023-08-30T07:45:59Z

harmonic/troubleshooting.md line 54 the dlopen error has both harmonic and libgz-physics6 in it... That looks like it's a find+replace thing from the Garden page. Maybe should just change it back to garden since harmonic is with physics7, and that error message shouldn't be fabricated manually.
Same for line 57.

Makes sense, reverted the error message back to that of Garden.

azeey · 2023-08-30T14:52:51Z

@azeey to double check - Harmonic is Jammy and 24.04 right?

Correct.

Regarding where to put some of the new features, if it doesn't make sense to add it here, remember that all the new features will be included in a changelog/release notes that accompanies the release announcement.

Signed-off-by: Dharini Dutia <[email protected]>

azeey

There are some changes that are in Garden, but not in the Harmonic directory.
examples:

Warning at the top of the windows install page
A sentence about MESA_GL_VERSION_OVERRIDE in troubleshooting.md

Can you do a diff and see if there are other changes?

harmonic/index.yaml

harmonic/install.md

harmonic/install_osx.md

harmonic/install_osx_src.md

mabelzhang · 2023-08-30T20:58:44Z

Can we do a quick fix on this?

There's also a typo in garden/install.md, where it says "uses the Gazebo brand instead of Gazebo", the second Gazebo should be Ignition. That can be in a separate PR later.

mabelzhang · 2023-08-30T21:01:12Z

@azeey Looking from the roadmap spreadsheet, is it correct to say there are Python bindings for gz-physics and gz-sim in Harmonic? (gz-math and sdformat are from previous releases)
Any other libraries?
I'm adding a section in the comparison page to just talk about python bindings.

Signed-off-by: Dharini Dutia <[email protected]>

azeey · 2023-08-30T21:06:34Z

There are python bindings for gz-transport and gz-sim. We should also have the ability to write Gazebo systems using python. That being said, I think it would be best to merge this PR and add that section in a follow up because we need the Harmonic directory created for yatm to find them and generate corresponding issues for the tutorial party.

Signed-off-by: Dharini Dutia <[email protected]>

mabelzhang · 2023-08-30T21:39:26Z

Okay. In that case, I don't have anything else to commit.
I'll do another review after I'm back from another meeting.

quarkytale requested a review from mabelzhang as a code owner August 24, 2023 22:22

quarkytale added the 🎵 harmonic Gazebo Harmonic label Aug 24, 2023

quarkytale requested a review from azeey August 24, 2023 22:22

copied over tutorials and other pages

acc5178

Signed-off-by: Dharini Dutia <[email protected]>

quarkytale force-pushed the quarkytale/harmonic branch from 077256a to acc5178 Compare August 24, 2023 22:26

azeey added the beta label Aug 28, 2023

forward port docs from Garden

8f2fde6

Signed-off-by: Mabel Zhang <[email protected]>

mabelzhang reviewed Aug 29, 2023

View reviewed changes

feature comparison page for Harmonic

c557a9c

Signed-off-by: Mabel Zhang <[email protected]>

ubuntu support versions

9143ed7

Signed-off-by: Mabel Zhang <[email protected]>

quarkytale and others added 2 commits August 30, 2023 00:37

Apply suggestions from code review

7867212

Co-authored-by: Mabel Zhang <[email protected]> Signed-off-by: Dharini Dutia <[email protected]>

revert troubleshooting error to garden

b8bb92b

Signed-off-by: Dharini Dutia <[email protected]>

extra line

08dad38

Signed-off-by: Dharini Dutia <[email protected]>

github-actions bot added the 🌱 garden Gazebo Garden label Aug 30, 2023

quarkytale force-pushed the quarkytale/harmonic branch from b052e28 to 08dad38 Compare August 30, 2023 17:53

bin install prerelease

1aeae34

Signed-off-by: Dharini Dutia <[email protected]>

azeey reviewed Aug 30, 2023

View reviewed changes

harmonic/index.yaml Show resolved Hide resolved

harmonic/install.md Outdated Show resolved Hide resolved

harmonic/install_osx.md Outdated Show resolved Hide resolved

harmonic/install_osx_src.md Outdated Show resolved Hide resolved

added comparison key, windows warning, removed catalina

bddb304

Signed-off-by: Dharini Dutia <[email protected]>

quarkytale added 2 commits August 30, 2023 21:07

naming typo in garden

95be435

Signed-off-by: Dharini Dutia <[email protected]>

added changes from Garden diff

aae926a

Signed-off-by: Dharini Dutia <[email protected]>

azeey approved these changes Aug 30, 2023

View reviewed changes

azeey merged commit 9a962b2 into azeey/harmonic Aug 30, 2023
1 check passed

azeey deleted the quarkytale/harmonic branch August 30, 2023 21:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added tutorials in Harmonic #372

Added tutorials in Harmonic #372

quarkytale commented Aug 24, 2023 •

edited

Loading

mabelzhang left a comment •

edited

Loading

mabelzhang Aug 29, 2023

quarkytale Aug 30, 2023

mabelzhang Aug 30, 2023

mabelzhang Aug 30, 2023 •

edited

Loading

quarkytale Aug 30, 2023

quarkytale Aug 30, 2023

mabelzhang commented Aug 29, 2023

mabelzhang commented Aug 30, 2023 •

edited

Loading

mabelzhang commented Aug 30, 2023

quarkytale commented Aug 30, 2023 •

edited

Loading

azeey commented Aug 30, 2023

azeey left a comment

mabelzhang commented Aug 30, 2023

mabelzhang commented Aug 30, 2023

azeey commented Aug 30, 2023

mabelzhang commented Aug 30, 2023

Added tutorials in Harmonic #372

Added tutorials in Harmonic #372

Conversation

quarkytale commented Aug 24, 2023 • edited Loading

mabelzhang left a comment • edited Loading

Choose a reason for hiding this comment

mabelzhang Aug 29, 2023

Choose a reason for hiding this comment

quarkytale Aug 30, 2023

Choose a reason for hiding this comment

mabelzhang Aug 30, 2023

Choose a reason for hiding this comment

mabelzhang Aug 30, 2023 • edited Loading

Choose a reason for hiding this comment

quarkytale Aug 30, 2023

Choose a reason for hiding this comment

quarkytale Aug 30, 2023

Choose a reason for hiding this comment

mabelzhang commented Aug 29, 2023

mabelzhang commented Aug 30, 2023 • edited Loading

mabelzhang commented Aug 30, 2023

quarkytale commented Aug 30, 2023 • edited Loading

azeey commented Aug 30, 2023

azeey left a comment

Choose a reason for hiding this comment

mabelzhang commented Aug 30, 2023

mabelzhang commented Aug 30, 2023

azeey commented Aug 30, 2023

mabelzhang commented Aug 30, 2023

quarkytale commented Aug 24, 2023 •

edited

Loading

mabelzhang left a comment •

edited

Loading

mabelzhang Aug 30, 2023 •

edited

Loading

mabelzhang commented Aug 30, 2023 •

edited

Loading

quarkytale commented Aug 30, 2023 •

edited

Loading