-
Notifications
You must be signed in to change notification settings - Fork 83
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
Simplify expression for tangent in hyperelasticity tutorial #852
base: master
Are you sure you want to change the base?
Conversation
KnutAM
commented
Dec 5, 2023
- Simplify expression for tangent
- Use new admonition syntax
- Add test for simplified equation (not sure if this should be kept, but nice if there are future changes)
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #852 +/- ##
=======================================
Coverage 93.08% 93.08%
=======================================
Files 34 34
Lines 5163 5163
=======================================
Hits 4806 4806
Misses 357 357 ☔ View full report in Codecov by Sentry. |
#md # ```@raw html | ||
#md # </div></details> | ||
#md # ``` | ||
# !!! details "Derivation of $\partial \mathbf{P} / \partial \mathbf{F}$" |
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.
This will only work for Documenters HTML output, not the notebooks (xref https://fredrikekre.github.io/Literate.jl/v2/tips/#admonitions-compatibility)
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.
Oh, is that the same above from #846 ?
Or is it just the math in the header?
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.
Yea, see https://nbviewer.org/github/Ferrite-FEM/Ferrite.jl/blob/gh-pages/dev/tutorials/hyperelasticity.ipynb (forgot about this while reviewing that PR)
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.
Also the link in the docs hasn't been updated since the "example" time...
What do you think about introducing the preprocessing commands suggested in the Literate docs?
Would be quite nice to be able to use admonitions in the examples.
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.
The citation is also broken x.x
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.
I couldn't figure out a nice way to make this work.
So for now, I've added the suggested #md # !!! note
type of filtering.
Since this is just extra information, I don't think it is required to have it in the notebook?
Also updated the link