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 of c3dFileAdapter in Opensim Wiki seems to be out of date #3996

Open
lks-dev opened this issue Jan 24, 2025 · 2 comments
Open
Assignees

Comments

@lks-dev
Copy link

lks-dev commented Jan 24, 2025

Documentation of the usage of the (c3d) FileAdapters in Python to import c3d/mot/sto files in the opensim wiki seems to be outdated.

Neither the c3d fileadapter nor the the shown usage of the sto fileadapters is working with opensim 4.5.1. An Update or an explicit reference to the version would be great, otherwise the experience using the wiki/opensim can be quite frustrating.

In the Opensim API Reference a up to date usage example is given as part of the documentation of the Force Location parameter

In general, it would be welcome to have more python examples in the Opensim API reference as a versioned and single resource about the usage of the python API. :)

@aymanhab
Copy link
Member

I agree the documentation is stale, I think a better approach than adding another snippet (for python) would be to have a live jupyter notebook with working code (possibly for the last published version and/or bleeding edge codebase).

@aymanhab aymanhab self-assigned this Jan 28, 2025
@lks-dev
Copy link
Author

lks-dev commented Jan 29, 2025

The Show don't tell approach is probably a good idea, especially as you can integrate it in the release process, insuring that the examples work or break 'loudly'.
Upon thinking about recommending place the example in a plain python file in the examples to make it consistent and hopefully easy to find. I stumbled upon the tests directory where the usage of the FileAdapters is exemplified in test_DataAdapter.py. tests is another place to find working usage examples, that, to my knowledge, is not advertised in the opensim wiki as a scripting resource.

Maybe this directory could be linked in the wiki and or included in the /Opensim/<Version>/Code directory to have all resources in a centralized place?

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

No branches or pull requests

2 participants