Deleted A Study of Studies - moved its content#42
Conversation
JacobAdamsen
requested review from
Hamedshayestehpour,
Kristofferiversen and
melund
as code owners
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 focuses on updating the "Getting Started" tutorial for the AnyBody Modeling System. The changes include adding a new lesson (Lesson 4) explaining simulations, modifying existing lessons to improve clarity and correct code snippets, and incorporating real bone geometries using STL files. The updates also involve changes to driver definitions and the introduction of AnyKinMotion as an alternative driver.
Highlights
- New Lesson: Understanding Simulations: A new lesson (Lesson 4) has been added to explain studies and operations, which are core components of simulations in AnyBody Modeling System. It covers the hierarchy of study classes and the structure of a study.
- Driver Updates: The pull request updates the driver definitions in several code snippets, replacing
AnyKinEqSimpleDriverwithAnyKinDriverand updating properties likeDriverPosandDriverVeltoDriverPos0andDriverVel0respectively. It also introducesAnyKinMotionas an alternative driver. - STL Integration: The tutorial now includes instructions on importing and manipulating STL files to add real bone geometries to the model, enhancing the visual representation.
- Lesson 5 Updates: Lesson 5 has been updated with new content, including an alternative driver AnyKinMotion, and external loads. Snippets have been updated to reflect these changes.
Changelog
Click here to see the changelog
- A_Getting_started/index.md
- Added an anchor link.
- A_Getting_started/intro.md
- Changed headings from '#' to '##' for 'Setup the AMMR' and 'AMMR structure'.
- A_Getting_started/lesson4.md
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0. - Updated the tutorial to refer to
ArmStudyinstead ofArmModelStudy.
- Replaced
- A_Getting_started/lesson5.md
- Added content about
AnyKinMotionas an alternative driver. - Updated code snippets to reflect changes in driver definitions.
- Added instructions on creating external loads.
- Corrected snippet references and added missing snippets.
- Added content about
- A_Getting_started/lesson6.md
- Added instructions on importing and manipulating STL files.
- Updated code snippets to reflect changes in STL integration.
- A_Getting_started_anyscript/Downloads/demo.lesson5.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Downloads/demo.lesson6.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson4/snip.NewModel.main-1.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson4/snip.NewModel.main-2.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson5/snip.NewModel.main-1.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson5/snip.NewModel.main-2.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson5/snip.NewModel.main-3.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson5/snip.NewModel.main-4.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson5/snip.NewModel.main-5.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson5/snip.NewModel.main-6.any
- Added
AnyRefNode PalmNodeto theForeArmsegment. - Added
AnyFolder Loadsto theMainfolder.
- Added
- A_Getting_started_anyscript/Snippets/lesson5/snip.NewModel.main-7.any
- Removed
AnyRefNode PalmNodefrom theForeArmsegment. - Added
AnyFolder DriverswithAnyKinMotiondrivers. - Removed
AnyFolder Loadsfrom theMainfolder.
- Removed
- A_Getting_started_anyscript/Snippets/lesson6/snip.NewModel.main-1.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson6/snip.NewModel.main-2.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson6/snip.NewModel.main-3.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson6/snip.NewModel.main-4.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_Getting_started_anyscript/Snippets/lesson6/snip.NewModel.main-5.any
- Replaced
AnyKinEqSimpleDriverwithAnyKinDriver. - Updated
DriverPosandDriverVeltoDriverPos0andDriverVel0.
- Replaced
- A_study_of_studies/index.md
- Marked the page as deleted.
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.
In AnyScript's domain,
Models rise, complex and sane,
STL's grace appears,
Bones banish all fears,
Motion's dance, a visual gain.
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.
Code Review
The pull request introduces a new lesson to the "Getting Started" tutorial series for the AnyBody Modeling System, focusing on understanding simulations. It also includes updates to existing lessons and code snippets to reflect changes in the AnyBody scripting language. The content appears well-structured and informative, providing a good introduction to key concepts. However, there are a few areas where improvements can be made to enhance clarity and correctness.
Summary of Findings
- Driver Class Updates: The code snippets and lesson content need to be consistent regarding the driver class used (AnyKinDriver vs. AnyKinEqSimpleDriver) and the corresponding properties (DriverPos0/DriverVel0 vs. DriverPos/DriverVel). There are inconsistencies that could confuse the reader.
- Inaccurate Study Name: Lesson 4 refers to 'ArmModelStudy' when it should be 'ArmStudy'. This needs to be corrected for consistency.
- Snippet Inclusion Consistency: Some snippets are included with start and end markers, while others are not. Consistency in snippet inclusion would improve readability.
Merge Readiness
The pull request has several medium severity issues that should be addressed before merging. Specifically, the inconsistencies in driver class usage and study names need to be resolved to avoid confusing users. I am unable to approve this pull request, and recommend that another reviewer also approves this code before merging.
| The objective of this tutorial is to demonstrate some of the features of | ||
| the AnyBody Modeling System using an existing model. | ||
| The objective of this tutorial is to demonstrate some of the features of the | ||
| AnyBody Modeling System using an existing model. The reader will get an |
There was a problem hiding this comment.
Consider removing the "(Deleted)" from the title. Is this page really deleted or is it just a note for the author?
| The folder contains two objects named `ShoulderMotion` and `ElbowMotion`, | ||
| belonging to the `AnyKinDriver ` class. |
There was a problem hiding this comment.
The text refers to AnyKinDriver , but the code snippets use AnyKinEqSimpleDriver. Please ensure consistency between the text and the code examples. Is AnyKinDriver the correct class to use here?
| `AnyKinDriver ` class used in this case, constrains the supplied | ||
| measure's positions to a given value at time = 0 (`DriverPos0`) and changes this | ||
| position at constant velocity thereon (`DriverVel0`). |
There was a problem hiding this comment.
The text refers to DriverPos0 and DriverVel0, but the code snippets use DriverPos and DriverVel. Please ensure consistency between the text and the code examples. Is DriverPos0 and DriverVel0 the correct property to use here?
|
|
||
| **You must now run the "Main.ArmModelStudy.Kinematics" operation. If you need to refer back to how this is done, look at** | ||
| {ref}`this prior tutorial <running-analysis>`. | ||
| You must now run the **"Main.ArmStudy.Kinematics"** operation. If you need to |
There was a problem hiding this comment.
The text refers to Main.ArmModelStudy.Kinematics, but it should be Main.ArmStudy.Kinematics. Please correct the study name.
JacobAdamsen
changed the title
2 participants
Excluded the tutorial A Study of Studies and moved it content to other tutorials.
Added a Lesson 4 to "Getting Started - First Steps" tutorial called Understanding Simulations
- Explains what studies are operations generally are
Updated tutorial "Getting Started with AnyScript" to use AnyKinDriver instead of AnyKinEqSimpleDriver
Added section about AnyKinMotion in Lesson 5 of "Getting Started with AnyScript"
And other general updates of these tutorials