Skip to content

[Examples] Clean up for V1 release#502

Merged
skim0119 merged 18 commits intoGazzolaLab:update-v1from
skim0119:mod/examples-timestepper
Oct 29, 2025
Merged

[Examples] Clean up for V1 release#502
skim0119 merged 18 commits intoGazzolaLab:update-v1from
skim0119:mod/examples-timestepper

Conversation

@skim0119
Copy link
Collaborator

@skim0119 skim0119 commented Sep 28, 2025

Description

Temporary documentation page for this PR

We have tutorials scattered in multiple locations. This is an attempt to unify the information, so that the contents and code can be maintained consistently.

Changes in Examples

  • Binder migrated into documentation
  • Case Examples section added using sphinx-gallery
  • Axial Stretching, Catenary, Timoshenko, Butterfly, Knot, and Continuum snake used for gallery, and codes were modified accordingly.
  • sphinxcontrib-video used to include mp4 assets in documentation.
  • Modules .using no longer returns private variable -- avoid unnecessary printout on ipython notebook cells.
  • Change examples to use timestepping loop instead of integrate.

Note

  • To include example in the gallery: add readme (blank is okay) into the folder, and rename the main script with run_.
  • If main script starts with run-, gallery will be created but the code will not run.

@skim0119 skim0119 changed the base branch from master to update-v1 September 28, 2025 21:51
@skim0119 skim0119 force-pushed the mod/examples-timestepper branch from 7dc13e2 to 14ac8d4 Compare October 10, 2025 17:48
@skim0119 skim0119 force-pushed the mod/examples-timestepper branch from 14ac8d4 to f0951f6 Compare October 17, 2025 17:34
@skim0119 skim0119 mentioned this pull request Oct 17, 2025
5 tasks
@skim0119 skim0119 requested a review from Ali-7800 October 25, 2025 23:13
@skim0119 skim0119 marked this pull request as ready for review October 26, 2025 06:39
@skim0119 skim0119 self-assigned this Oct 26, 2025
@skim0119 skim0119 added the documentation Improvements or additions to documentation label Oct 26, 2025
@skim0119 skim0119 force-pushed the mod/examples-timestepper branch from ebc9431 to 046df44 Compare October 26, 2025 06:50
@skim0119 skim0119 force-pushed the mod/examples-timestepper branch from 1360042 to cac0229 Compare October 26, 2025 20:14
Copy link
Collaborator

@Ali-7800 Ali-7800 left a comment

Choose a reason for hiding this comment

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

LGTM

@skim0119 skim0119 merged commit bbdaba5 into GazzolaLab:update-v1 Oct 29, 2025
9 checks passed
@skim0119 skim0119 deleted the mod/examples-timestepper branch October 29, 2025 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants