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

Create ign-physics tutorials #67

Closed
13 tasks
claireyywang opened this issue Jun 17, 2020 · 4 comments
Closed
13 tasks

Create ign-physics tutorials #67

claireyywang opened this issue Jun 17, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@claireyywang
Copy link
Contributor

claireyywang commented Jun 17, 2020 •
edited
Loading

Some tutorial ideas for ign-physics

Getting started

  • what is ign-physics, motivation of creating this library, where to find repo, versions released
  • currently supported physics engines and corresponding features overview
  • roadmap of future plans of ign-physics, potential timeline of certain features to look forward to
  • where to download debian, how to source build/compile

For users

  • how to switch between default and additional physics engine
  • chapters where users try out different physics features
    • bottom up approach: step by step tutorials on how to set/add various models with different physics features like (rigid body dynamics, collision detection, kinematics to compose a world
      OR
    • top down approach: given a world of various models, zoom in onto each model and see how forces are set, position is updated or any other physics features work

For developers

  • high level overview of how physics plugin work, explain user interface and implementation interface, key concepts/classes (Entities), link to API documentation and contributing guide
  • explain folder structure and where to add new custom features, potential restrictions on adding custom features
  • a step by step interactive tutorial teaching how to add a simple custom plugin, using the hello-world plugin example
  • a tutorial on how to define custom features in a plugin and request them when loading plugins using the dartsim RetrieveWorld feature in World.hh
  • use TPE as a more advanced example. Pick one FeatureList as step-by-step tutorial on how to implement features using external physics engine API.
@claireyywang claireyywang added the documentation Improvements or additions to documentation label Jun 17, 2020
@chapulina
Copy link
Contributor

I'll leave a cross-reference to this issue because some questions that are popping up there could be good to answer on these tutorials: leggedrobotics/raisimLib#40

@scpeters
Copy link
Member

I think it would also be make a tutorial about how to define custom features in a plugin and request them when loading plugins. We can use the dartsim RetrieveWorld feature in World.hh as an example.

@chapulina chapulina added the help wanted Extra attention is needed label Jun 22, 2020
@claireyywang
Copy link
Contributor Author

I think it would also be make a tutorial about how to define custom features in a plugin and request them when loading plugins. We can use the dartsim RetrieveWorld feature in World.hh as an example.

Good point! Adding it to the list...

@claireyywang
Copy link
Contributor Author

Closing since most PRs are merged and tracked in separate issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@scpeters @chapulina @claireyywang