Skip to content

Conversation

nickbianco
Copy link
Member

@nickbianco nickbianco commented Aug 7, 2025

Brief summary of changes

This PR adds the suite of Python tutorials from the opensim-models repo to opensim-core for better user visibility. I've used this as an opportunity to make various improvements, typo corrections, and other fixes to the notebooks (although other small issues may persist).

All of the tutorial files are linked to a new shared folder in the NMBL Google Drive: https://drive.google.com/drive/u/1/folders/13rHbuv5fvC2l-N1S3PfobJP467UKts00

For review, it may be easiest to open each notebook directly from the branch on my fork: https://github.com/nickbianco/opensim-core/tree/python_examples/Bindings/Python/tutorials

Testing I've completed

Ran through tutorials on Google Colab and locally using the OpenSim conda package.

Looking for feedback on...

CHANGELOG.md (choose one)

  • updated.

This change is Reviewable

@nickbianco nickbianco marked this pull request as ready for review August 7, 2025 21:33
@nickbianco nickbianco changed the title [WIP] Add Jupyter notebooks with OpenSim Python tutorials Add Jupyter notebooks with OpenSim Python tutorials Aug 7, 2025
@AlbertoCasasOrtiz
Copy link
Contributor

I have reviewed all tutorials, checked that all links worked, and run through all of them. The only blocking error is in Tutorial 8, where a file cannot be downloaded.

Tests completed:

  • Tutorial 1
  • Tutorial 2
  • Tutorial 3
  • Tutorial 4
  • Tutorial 5
  • Tutorial 6 -> Loading the model complaints about missing vtp files. This error appears multiple times. We should explain users at least once that this is not something to worry about here, as we are not visualizing.
  • Tutorial 7
  • Tutorial 8 -> When downloading the zip file I get (The file is not a valid zip file), so it is not downloaded. I downloaded manually from drive to continue and everything else seems to work as expected.

Note: In all tutorials that link to Tutorial 1 or any other colab book (Example: Tutorial 1: Introduction to OpenSim). It opens a drive link with the RAW text of the colab notebooks. At the top there is a button to open in colab, but I think it would be better if we could redirect to a colab session instead of to a drive file.

The links from the table in tutorial 6 work as expected (https://colab.research.google.com/github/nickbianco/opensim-core/blob/python_examples/Bindings/Python/tutorials/Tutorial%201%20-%20Introduction%20to%20OpenSim.ipynb), so maybe those could be used.

@nickbianco
Copy link
Member Author

Thanks @AlbertoCasasOrtiz, all the links should be fixed now.

Note that once this is merged, I will have to create a follow-up PR to update the Google Colab links to the notebooks in opensim-core. I can't do that yet because they don't actually exist on main until we merge this PR.

Copy link
Contributor

@AlbertoCasasOrtiz AlbertoCasasOrtiz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Let me know once you create a PR with the links to the notebooks to review them.

@nickbianco nickbianco merged commit c8bda59 into opensim-org:main Aug 19, 2025
8 of 10 checks passed
@nickbianco nickbianco deleted the python_examples branch August 19, 2025 17:47
@nickbianco
Copy link
Member Author

Thanks @AlbertoCasasOrtiz!

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.

2 participants