KratosMultiphysics / Kratos

Kratos Multiphysics (A.K.A Kratos) is a framework for building parallel multi-disciplinary simulation software. Modularity, extensibility and HPC are the main objectives. Kratos has BSD license and is written in C++ with extensive Python interface.
https://kratosmultiphysics.github.io/Kratos/
Other
1.05k stars 246 forks source link

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

Closed avdg81 closed 1 month ago

avdg81 commented 1 month ago

📝 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](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions) on GitHub Docs.