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.

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

Documentation #1986

Merged
merged 10 commits into from Jun 3, 2023
Merged

Documentation #1986

merged 10 commits into from Jun 3, 2023

Conversation

drewhamiltonasdf
Copy link
Contributor

A handful of updates to the documentation to get rid of deprecated python commands etc., a few grammar fixes, missing packages etc.

robot.initDisplay(loadModel=True) is deprecated
robot.initViewer(loadModel=True) preferred.
Fix broken LaTeX formatting for "using quaternions" title. Fixed grammar, "a SO(3) object" should be "an SO(3) object"
Newer package names available from http://robotpkg.openrobots.org/robotpkg/index.html

This is what I used with a fresh install yesterday and everything is working.
Use @ for matrix multiplication. Previous version does not run in 3.10.
skew now in main pinocchio namespace. cross deprecated in current version of pin, np.cross preferred.
semicolons not particularly pythonic
More semicolons cleaned
Using robot_description is probably a bit more future-proof. The current version does not work as the actual path is /opt/openrobots/share/example-robot-data/robots/ur_description/urdf/ur5_gripper.urdf
package robotpkg-ur5-description does not exist and robot_wrapper.py does not work out of the box with local path to example-robot-data, throwing an error: '''ValueError: Mesh package://example-robot-data/robots/ur_description/meshes/ur5/collision/base.stl could not be found.'''
@jcarpent
Copy link
Contributor

jcarpent commented Jun 3, 2023

Thanks a lot @drewhamiltonasdf. This looks nice to me.
We can even go further by removing the use of gepetto-gui and using meshcat viewer instead.

@drewhamiltonasdf
Copy link
Contributor Author

Thanks a lot @drewhamiltonasdf. This looks nice to me. We can even go further by removing the use of gepetto-gui and using meshcat viewer instead.

No problem. I can go back to some of the earlier docs and update to MeshCat. Is gepetto-gui completely out of favor now? Also wondering if RobotWrapper.py is still the preferred URDF import method for custom URDF's? I'm going to have to dig into loading custom URDF packages eventually...

@jcarpent
Copy link
Contributor

jcarpent commented Jun 3, 2023

Is gepetto-gui completely out of favor now?

Yes, it is no more the way to go. The generic approach relies on Meshcat which is multiplatform and more flexible.

Also wondering if RobotWrapper.py is still the preferred URDF import method for custom URDF's?

It is a helper class. But for best performances, it is better to rely on a separate model and data, loaded via the custom URDF parser.

@jcarpent
Copy link
Contributor

jcarpent commented Jun 3, 2023

@drewhamiltonasdf A small suggestion, it would be better to squeeze your commits when they are related to the same change. You can use git commit --amend to amend the last commit with the latest modfications.

@drewhamiltonasdf
Copy link
Contributor Author

@drewhamiltonasdf A small suggestion, it would be better to squeeze your commits when they are related to the same change. You can use git commit --amend to amend the last commit with the latest modfications.

Will do going forward. Thanks!

@jcarpent
Copy link
Contributor

jcarpent commented Jun 3, 2023

I'm merging this first PR.
Thanks @drewhamiltonasdf for this nice and helpful contribution. We are looking forward to further doc improvements thanks to you.

@jcarpent jcarpent merged commit 85d7d95 into stack-of-tasks:devel Jun 3, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants