Create a Visual Example Gallery for examples and tutorials

klshrinidhi commented 8 years ago

The goal (in my mind) is to have about 10 full fledged end-to-end examples (like the Hopper example) to form the Example Gallery. It would be good to pool in ideas. We could potentially merge two or more ideas into one example.

Update/improve existing examples.
Example to show contact modeling (e.g., create a tire model and build a car that can be controlled using the arrow keys).
Example to demonstrate creating a custom joint.
Post hoc analysis using StatesTrajectory.
End-to-end pipeline using .c3d file.
Stitch together a Frankenmodel comprised of existing Models.
Example to show off new visualizer (e.g., something like this where the cylinder moves).

chrisdembia commented 8 years ago

I like those ideas a lot. We already have some good examples that could go in the gallery (making a muscle model, performing an optimization). What about an example focused on custom visualization?

I'm interested in the format of the gallery: are you thinking of a website with images, walkthroughs, etc.? Something like what Gazebo has? http://gazebosim.org/tutorials?cat=guided_i&tut=guided_i1

tkuchida commented 8 years ago

are you thinking of a website with images, walkthroughs, etc.?

Images would be great. Is it feasible to embed the new visualizer into a webpage so a user can immediately interact with (e.g., rotate, zoom) the finished model without downloading any files or firing up the GUI?

I like the level of explanation given in the hopper example README.md (though we may decide to house this information on Confluence rather than a GitHub README). I'd personally prefer to read well-documented code than a walkthrough on a separate webpage.

klshrinidhi commented 8 years ago

Not decided on the format yet. Examples as web-pages are good for instant access but downside we have to keep them updated. Keeping the examples in the repo makes it easier for us to keep them up updated with changes to the API. I think we should think of a way to get the best of both -- by somehow displaying examples pulled from the repository when the webpage is opened.

klshrinidhi commented 8 years ago

Another potential example came out of today's meeting:

A pipeline example using C3D files as input. This will be mostly a copy of currently existing example that reads TRC file, runs IK/ID etc.

chrisdembia commented 8 years ago

I think we should think of a way to get the best of both

+1. See this stackoverflow question.

A pipeline example using C3D files as input. This will be mostly a copy of currently existing example that reads TRC file, runs IK/ID etc.

I like this, especially as a matlab/python example.

sebastianskejoe commented 8 years ago

As a new user, the examples I have been missing the most are:

How to setup a pipeline in MATLAB.
How to perform a forward dynamics optimization in MATLAB.

At our university (and I think this is the case for a lot of universities) students are only taught how to use MATLAB, and we want to use OpenSim mostly for performing static optimization on a bunch of C3D-files, since the majority of our work is in this area. However, we also want to have a better tool than home-brewed MATLAB-scripts for performing forward dynamics optimization, but to be honest I have not figured out how to do this in MATLAB with OpenSim. Having a complete example of something like optimizing the speed of the endpoint of a two-segment model with muscles (simulating a throw or soccer kick), would be great!

I will be happy to help develop these examples but as mentioned I don't really know where to start (which may just be me not knowing where to look

the wiki can be a confusing place :) ).

tor. 28. jul. 2016 kl. 23.03 skrev Christopher Dembia < notifications@github.com>:

I think we should think of a way to get the best of both

+1. See this stackoverflow question http://stackoverflow.com/questions/28338017/is-there-a-way-to-embed-github-code-into-an-iframe .

A pipeline example using C3D files as input. This will be mostly a copy of currently existing example that reads TRC file, runs IK/ID etc.

I like this, especially as a matlab/python example.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/opensim-org/opensim-core/issues/1144#issuecomment-236024514, or mute the thread https://github.com/notifications/unsubscribe-auth/AAsV6D1OPMVVBucq5ii2ldLwZWArIqLNks5qaRkmgaJpZM4JXjxK .

chrisdembia commented 8 years ago

@sebastianskejoe that is very helpful. Thank you. For your immediate needs, I would look at the dynamic walker example (http://simtk-confluence.stanford.edu:8080/pages/viewpage.action?pageId=5113821)

jenhicks commented 8 years ago

FYI, the current set of examples are listed here: http://simtk-confluence.stanford.edu:8080/display/OpenSim/Examples+and+Tutorials

I see two separate issues: 1) How to make the current examples easier to find, navigate, keep up-to-date 2) Create new examples to document new features and fill gaps.

@jimmyDunne some of this discussion could be helpful as you prep the doc and example slides.

opensim-org / opensim-core

Create a Visual Example Gallery for examples and tutorials #1144