-
Notifications
You must be signed in to change notification settings - Fork 2
Muscle modeling updates #41
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @JacobAdamsen, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request updates the muscle modeling lessons with various improvements. These include adding image widths for better display, clarifying instructions for inserting muscle objects, correcting code snippets, and updating content for clarity and accuracy. The changes span across lessons 1 through 7, covering topics from basic muscle modeling to advanced concepts like ligament calibration.
Highlights
- Image Widths: Image widths have been added to multiple lessons to improve the display and formatting of images within the lessons.
- Instruction Clarification: Instructions for inserting AnyMuscleViaPoint and AnyDrawMuscle objects have been clarified in lessons 1 and 2, respectively, to guide users more effectively.
- Code Snippet Corrections: Several code snippets have been corrected or updated across lessons 4, 5, and 6 to ensure accuracy and proper functionality.
- Content Updates: Content updates have been made in lessons 5 and 7 to improve clarity, correct errors, and enhance the overall learning experience.
- Warning Message Update: The warning message in lesson 4 has been updated to provide more accurate and helpful information regarding via-point locations and wrapping surfaces.
Changelog
Click here to see the changelog
- Muscle_modeling/lesson1.md
- Added
width
attribute to image directives to control image sizes. - Replaced instructions for inserting AnyMuscleViaPoint with a clearer method using the Class List.
- Removed image related to inserting AnyMuscleViaPoint.
- Replaced
AnyMuscleViaPoint
withAnyViaPointMuscle
and updated the corresponding code snippet. - Corrected download link text.
- Added
- Muscle_modeling/lesson2.md
- Added
width
attribute to the first image directive. - Clarified instructions for inserting AnyDrawMuscle using the Class List instead of the class tree.
- Removed image related to inserting AnyDrawMuscle.
- Added
width
attribute to the second image directive.
- Added
- Muscle_modeling/lesson3.md
- Added
width
attribute to image directives to control image sizes.
- Added
- Muscle_modeling/lesson4.md
- Removed extra indentation from the AnySurfCylinder code block.
- Added
width
attribute to image directives to control image sizes. - Replaced
Any§ShortestPath§Muscle
with§AnyMuscleShortestPath§
. - Updated warning message regarding via-point location.
- Removed an extra § from the SPLine.InitWrapPosVectors line.
- Muscle_modeling/lesson5.md
- Removed commented-out lines in the AnyMuscleModel2ELin code block.
- Reformatted the muscle strength equation using the
math
directive. - Added a missing § to the V0 parameter definition.
- Added
width
attribute to image directives to control image sizes. - Corrected AnyMuscleModel3E code block.
- Corrected AnyMuscleModel3E Model3 code block.
- Updated image reference from image14.png to image35.png.
- Adjusted table widths.
- Muscle_modeling/lesson6.md
- Added
width
attribute to image directives to control image sizes. - Updated the NOTICE message to include 'other recruited actuators'.
- Corrected AnyMuscleGeneric code block.
- Removed an empty line between AnyKinEqSimpleDriver and AnyFolder Drivers.
- Added
- Muscle_modeling/lesson7.md
- Added
width
attribute to image directives to control image sizes. - Updated the LigStudy output path to include Main.
- Reformatted the ligament force equation using the
math
directive. - Corrected AnyLigamentModelPol code block.
- Added a level 3 heading for Calibration.
- Corrected AnyBodyCalibrationStudy code block.
- Removed extra text and backticks from the L0 description.
- Added
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
A muscle model's art,
With AnyScript, a fresh start,
Wrapping 'round the bone,
A strength that's shown,
In simulation's smart heart.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request includes updates to muscle modeling lessons, primarily focusing on adding image widths for better presentation and refining the descriptions and code snippets for clarity. The changes seem well-intentioned and contribute to a more polished learning experience.
Summary of Findings
- Inconsistent terminology: The lessons use both 'Class Tree' and 'Class List' to refer to the same concept. Maintaining consistent terminology would improve clarity for the reader.
- Inaccurate code snippets: Some code snippets in the lessons do not accurately reflect the intended functionality or have unnecessary elements. Ensuring the code is correct and concise is crucial for learning.
- Missing code block formatting: Some code snippets are missing the appropriate formatting, making them less readable and harder to distinguish from regular text.
Merge Readiness
The pull request improves the presentation and clarity of the muscle modeling lessons. However, there are a few issues that should be addressed before merging, particularly the inaccurate code snippets and inconsistent terminology. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging. Given the presence of medium and high severity issues, I recommend that the pull request not be merged until those are addressed.
Updates of Muscle Modeling tutorial