diff --git a/README.md b/README.md index cf8f9e087b1b2895d66171bd7ac5fa2fa478249c..374e8e393a7868a29e80fedae8880df5d39cb058 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,23 @@ CentOS Mellanox ``` +## Mathematical Formulae + +Formulas are made with: + +* https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/ +* https://www.mathjax.org/ + +You can add formula to page like this: + +``` +$$ +MAX\_FAIRSHARE * ( 1 - \frac{usage_{Project}}{usage_{Total}} ) +$$ +``` + +To enable the MathJX on page you need to enable it by adding line ```---8<--- "mathjax.md"``` at the end of file. + ## Developemnt Environment ### MkDocs diff --git a/docs.it4i/anselm/job-priority.md b/docs.it4i/anselm/job-priority.md index 06c7e921d38a35fac318acc7485dcf2c1a015ddf..30eba2bd004ff45ec5532d06ea556bdd08b7f56c 100644 --- a/docs.it4i/anselm/job-priority.md +++ b/docs.it4i/anselm/job-priority.md @@ -26,7 +26,7 @@ Fair-share priority is used for ranking jobs with equal queue priority. Fair-share priority is calculated as - +---8<--- "fairshare_formula.md" where MAX_FAIRSHARE has value 1E6, usage<sub>Project</sub> is cumulated usage by all members of selected project, @@ -52,7 +52,7 @@ Eligible time can be seen as eligible_time attribute of job. Job execution priority (job sort formula) is calculated as: - +---8<--- "job_sort_formula.md" ### Job backfilling @@ -68,3 +68,5 @@ It means, that jobs with lower execution priority can be run before jobs with hi It is **very beneficial to specify the walltime** when submitting jobs. Specifying more accurate walltime enables better scheduling, better execution times and better resource usage. Jobs with suitable (small) walltime could be backfilled - and overtake job(s) with higher priority. + +---8<--- "mathjax.md" diff --git a/docs.it4i/salomon/job-priority.md b/docs.it4i/salomon/job-priority.md index 265afe5441ba0ad549348c7de9edc07c3fb078fb..5455a1ac4df144a9defc62d7a6511b3890bac5e7 100644 --- a/docs.it4i/salomon/job-priority.md +++ b/docs.it4i/salomon/job-priority.md @@ -26,7 +26,7 @@ Fair-share priority is used for ranking jobs with equal queue priority. Fair-share priority is calculated as - +---8<--- "fairshare_formula.md" where MAX_FAIRSHARE has value 1E6, usage<sub>Project</sub> is cumulated usage by all members of selected project, @@ -53,7 +53,7 @@ Eligible time can be seen as eligible_time attribute of job. Job execution priority (job sort formula) is calculated as: - +---8<--- "job_sort_formula.md" ### Job backfilling @@ -73,3 +73,5 @@ Specifying more accurate walltime enables better scheduling, better execution ti ### Job Placement Job [placement can be controlled by flags during submission](job-submission-and-execution/#job_placement). + +---8<--- "mathjax.md" diff --git a/docs.it4i/snippets/fairshare_formula.md b/docs.it4i/snippets/fairshare_formula.md new file mode 100644 index 0000000000000000000000000000000000000000..eb8ee4a882c077de8c19aca6b04dfc1f3abfaf53 --- /dev/null +++ b/docs.it4i/snippets/fairshare_formula.md @@ -0,0 +1,3 @@ +$$ +MAX\_FAIRSHARE * ( 1 - \frac{usage_{Project}}{usage_{Total}} ) +$$ diff --git a/docs.it4i/snippets/job_sort_formula.md b/docs.it4i/snippets/job_sort_formula.md new file mode 100644 index 0000000000000000000000000000000000000000..ef66c56471a348109cdc5b725f840cefc671bd20 --- /dev/null +++ b/docs.it4i/snippets/job_sort_formula.md @@ -0,0 +1,3 @@ +$$ +1000*queue\_priority + \frac{fairshare\_priority}{1000} + \frac{eligible\_time}{864000} +$$ diff --git a/docs.it4i/snippets/mathjax.md b/docs.it4i/snippets/mathjax.md new file mode 100644 index 0000000000000000000000000000000000000000..4a3c0d865da60711f22c39eaa6e6757337745086 --- /dev/null +++ b/docs.it4i/snippets/mathjax.md @@ -0,0 +1,23 @@ +<script type="text/x-mathjax-config"> +MathJax.Hub.Config({ + config: ["MMLorHTML.js"], + jax: ["input/TeX", "output/HTML-CSS", "output/NativeMML"], + extensions: ["tex2jax.js", "MathMenu.js", "MathZoom.js"], + tex2jax: { + inlineMath: [ ["\\(","\\)"] ], + displayMath: [ ["\\[","\\]"] ] + }, + TeX: { + TagSide: "right", + TagIndent: ".8em", + MultLineWidth: "85%", + equationNumbers: { + autoNumber: "AMS", + } + }, + displayAlign: 'left', + showProcessingMessages: false, + messageStyle: 'none' +}); +</script> +<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> diff --git a/mkdocs.yml b/mkdocs.yml index 0c557765ed5ea27ccfd005a03f8c943a3947469e..0d147055f0d5ff9ede7e7b8684393927d02a7514 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -208,9 +208,13 @@ extra: markdown_extensions: - codehilite - - admonition - - toc: - permalink: '(H)' + - markdown.extensions.admonition: + - pymdownx.arithmatex: + - markdown.extensions.toc: + slugify: !!python/name:pymdownx.slugs.uslugify + permalink: î…— + - pymdownx.snippets: + base_path: docs.it4i/snippets google_analytics: - 'UA-90498826-1'