Skip to content
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

[GeoMechanicsApplication] Replace two images with matrix equations by proper math blocks #12801

Merged
merged 4 commits into from
Oct 29, 2024

Conversation

avdg81
Copy link
Contributor

@avdg81 avdg81 commented Oct 28, 2024

📝 Description

We have found that using pairs of $$ to enclose a math block in GitHub Markdown is not as robust as it should be. As a result, when the math rendering failed we created images of the equations to be displayed. After some searching I've found that there is an alternative (recommended) way of wrapping mathematical equations in GitHub Markdown (rather than using pairs of $$):

```math
(...the math goes here...)
```

When I wrapped the original LaTeX code for initial effective stresses using POP in such a block, the rendering worked as expected. This PR replaces two images of matrix equations by code that automatically generates these images.

Note that the above syntax is also documented here on GitHub Docs.

@avdg81 avdg81 added Documentation GeoMechanics Issues related to the GeoMechanicsApplication labels Oct 28, 2024
@avdg81 avdg81 requested review from indigocoral and WPK4FEM October 28, 2024 19:58
@avdg81 avdg81 self-assigned this Oct 28, 2024
Copy link
Contributor

@WPK4FEM WPK4FEM left a comment

Choose a reason for hiding this comment

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

Short and clear. Let's find the other occurrences in another PR.

Copy link
Contributor

@indigocoral indigocoral left a comment

Choose a reason for hiding this comment

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

Thank you for creating this pull request and finding a fix for it!

@indigocoral indigocoral merged commit 0643bd0 into master Oct 29, 2024
11 checks passed
@indigocoral indigocoral deleted the geo/restore-math-blocks-in-readme branch October 29, 2024 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation GeoMechanics Issues related to the GeoMechanicsApplication
Development

Successfully merging this pull request may close these issues.

3 participants