Adding Gazebo Docs #265
Adding Gazebo Docs #265
Conversation
|
|
||
| Robot simulation is an essential tool in every roboticist's toolbox. A well-designed simulator makes it possible to rapidly test algorithms, design robots, and perform regression testing using realistic scenarios. Gazebo offers the ability to accurately and efficiently simulate populations of robots in complex indoor and outdoor environments. At your fingertips is a robust physics engine, high-quality graphics, and convenient programmatic interfaces. Best of all, Gazebo is free with a vibrant community. | ||
|
|
||
| > [wikipedia.org/wiki/Gazebo_simulator ](https://en.wikipedia.org/wiki/Gazebo_simulator) |
There was a problem hiding this comment.
still working on this bit.
|
After looking around the docs a bit, and the discussion on the image PR, what's included here today is just the gzserver component, which is a headless simulator, and then I need a gzclient (which depends on hardware accelerated graphics through OGRE) to be able to "see" what's going on. I'm guessing there are still useful things that can be done without firing up the client? It would be great to provide more context about use cases for those of us that are new to Gazebo. It looks like my OS has a package for gazebo 5.1.0, and it connected to my gzserver container when it was running (and failed "Waiting on master" otherwise). Because of the way the gzclient works, I don't think we would be able to support it as an official image due to the X socket mounting and graphics drivers mess. The unlisted gzclient image runs in to issues for me, but not that interested in playing with it much further at the moment. It looks like gzserver puts some persistent data in /root/.gazebo, so having guidance on how to manage that would be helpful. Do you think it makes sense to make that folder a volume as well? |
|
👍 cool stuff |
|
Lots of spelling/grammar issues in the latest changes. In general, I still don't feel like I know what a "good" use case looks like. A trivial example would be useful to illustrate the flow of running a job and then collecting the results. Seeing BTW, the reason TravisCI isn't happy with this is due to the extra spaces at the end of content.md -- the markdownfmt.sh script can be used to check this with |
|
@psftw |
|
@ruffsl nice work on the expanded docs. LGTM apart from the broken Wikipedia link. I've sent over some suggested wording tweaks to also consider. I'm not sure how to appease the markdown gods either, but I added some extra newlines to the last section which might help. |
tweak wording
| ## Create a `Dockerfile` in your Gazebo project | ||
|
|
||
| FROM gazebo:gzserver5 | ||
| # place here your application's setup specifics |
There was a problem hiding this comment.
Is there a specific folder that a user should ADD their files to so that gzserver will find it?
There was a problem hiding this comment.
Where users should mount their files for gazebo is described in detail under the volumes section. I wouldn't recommend users bake-in worlds models or robot. sdf files into image itself using the ADD argument in the Dockerfile. Those files are usually dynamic in nature as the user tweaks or iterates designs during runtime.
|
Just a few small suggestions/nitpicks above. The travis failure is saying that you have |
as per @yosifkit suggestions
|
LGTM pending docker-library/official-images#855 |
|
LGTM |
See main PR here.