Added tutorials in Harmonic

gazebosim / docs

High-level Gazebo documentation that gets published to https://gazebosim.org/docs/

https://gazebosim.org/docs

44 stars 81 forks source link

Added tutorials in Harmonic #372

Closed quarkytale closed 10 months ago

quarkytale commented 10 months ago

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?

mabelzhang commented 10 months ago

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.

mabelzhang commented 10 months ago

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

mabelzhang commented 10 months ago

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

quarkytale commented 10 months ago

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 commented 10 months ago

@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.

mabelzhang commented 10 months ago

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 commented 10 months ago

@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.

azeey commented 10 months ago

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.

mabelzhang commented 10 months ago

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