docs: documenting using pymapdl on clusters by germa89 · Pull Request #3466 · ansys/pymapdl

germa89 · 2024-10-07T11:33:34Z

Description

Passing this env vars should smooth the multinode MAPDL execution.
Also, plenty of docs are added/expanded/improved.

EDIT:
Because I'm going to merge #3500 to main, this PR will only contains the doc review of that PR, hence I changed the PR name.

Issue linked

Related to #3397
Related to #3467

Checklist

…tps://github.com/ansys/pymapdl into feat/passing-tight-integration-env-vars-to-MAPDL

ansys-reviewer-bot · 2024-10-07T11:33:37Z

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

…tps://github.com/ansys/pymapdl into feat/passing-tight-integration-env-vars-to-MAPDL

Squashed commit of the following: commit c1d1a3e Author: German <28149841+germa89@users.noreply.github.com> Date: Mon Oct 7 15:33:19 2024 +0200 ci: retrigger CICD commit b7b5c30 Author: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon Oct 7 13:31:55 2024 +0000 ci: auto fixes from pre-commit.com hooks. for more information, see https://pre-commit.ci commit 32a1c02 Author: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Date: Mon Oct 7 15:31:24 2024 +0200 fix: add suggestions Co-authored-by: German <28149841+germa89@users.noreply.github.com> commit 575a219 Merge: f2afe13 be1be2e Author: Revathyvenugopal162 <revathy.venugopal@ansys.com> Date: Mon Oct 7 15:09:01 2024 +0200 Merge branch 'fix/add-build-cheatsheet-as-env-varaible' of https://github.com/ansys/pymapdl into fix/add-build-cheatsheet-as-env-varaible commit f2afe13 Author: Revathyvenugopal162 <revathy.venugopal@ansys.com> Date: Mon Oct 7 15:08:58 2024 +0200 fix: precommit commit be1be2e Author: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Mon Oct 7 13:07:35 2024 +0000 chore: adding changelog file 3468.fixed.md commit f052a4d Author: Revathyvenugopal162 <revathy.venugopal@ansys.com> Date: Mon Oct 7 15:05:56 2024 +0200 fix: add build cheatsheet as env variable within doc-build

…tps://github.com/ansys/pymapdl into feat/passing-tight-integration-env-vars-to-MAPDL

germa89 · 2024-10-07T14:46:00Z

Screenshots

PyMAPDL on HPC Clusters

Troubleshooting

doc/source/user_guide/hpc/pymapdl.rst

doc/source/user_guide/hpc/troubleshooting.rst

doc/source/user_guide/mapdl.rst

src/ansys/mapdl/core/launcher.py

PipKat

Mostly edits to make the content meet Ansys style guidelines.

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

…tps://github.com/ansys/pymapdl into feat/passing-tight-integration-env-vars-to-MAPDL

germa89 · 2024-10-23T16:11:30Z

Merging without finishing CICD because we still need to do a PR from this branch to main.

* docs: documenting using pymapdl on clusters (#3466) * feat: adding env vars needed for multinode * feat: adding env vars needed for multinode * feat: renaming hpc detection argument * docs: adding documentation * chore: adding changelog file 3466.documentation.md * feat: adding env vars needed for multinode * feat: renaming hpc detection argument * docs: adding documentation * chore: adding changelog file 3466.documentation.md * fix: vale issues * chore: To fix sphinx build Squashed commit of the following: commit c1d1a3e Author: German <28149841+germa89@users.noreply.github.com> Date: Mon Oct 7 15:33:19 2024 +0200 ci: retrigger CICD commit b7b5c30 Author: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon Oct 7 13:31:55 2024 +0000 ci: auto fixes from pre-commit.com hooks. for more information, see https://pre-commit.ci commit 32a1c02 Author: Revathy Venugopal <104772255+Revathyvenugopal162@users.noreply.github.com> Date: Mon Oct 7 15:31:24 2024 +0200 fix: add suggestions Co-authored-by: German <28149841+germa89@users.noreply.github.com> commit 575a219 Merge: f2afe13 be1be2e Author: Revathyvenugopal162 <revathy.venugopal@ansys.com> Date: Mon Oct 7 15:09:01 2024 +0200 Merge branch 'fix/add-build-cheatsheet-as-env-varaible' of https://github.com/ansys/pymapdl into fix/add-build-cheatsheet-as-env-varaible commit f2afe13 Author: Revathyvenugopal162 <revathy.venugopal@ansys.com> Date: Mon Oct 7 15:08:58 2024 +0200 fix: precommit commit be1be2e Author: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Date: Mon Oct 7 13:07:35 2024 +0000 chore: adding changelog file 3468.fixed.md commit f052a4d Author: Revathyvenugopal162 <revathy.venugopal@ansys.com> Date: Mon Oct 7 15:05:56 2024 +0200 fix: add build cheatsheet as env variable within doc-build * docs: expanding a bit troubleshooting advices and small format fix * docs: fix vale * fix: nproc tests * feat: adding env vars needed for multinode * feat: renaming hpc detection argument * docs: adding documentation * chore: adding changelog file 3466.documentation.md * fix: vale issues * docs: fix vale * docs: expanding a bit troubleshooting advices and small format fix * fix: nproc tests * revert: "chore: To fix sphinx build" This reverts commit e45d2e5. * docs: clarifying where everything is running. * docs: expanding bash example * tests: fix * docs: adding `PYMAPDL_NPROC` to env var section * docs: fix vale issue * docs: fix vale issue * fix: replacing env var name * fix: unit tests * chore: adding changelog file 3466.documentation.md [dependabot-skip] * Apply suggestions from code review Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com> * docs: apply suggestions from code review made by Kathy Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * docs: adding Kathy suggestion. --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com> Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> * chore: adding changelog file 3506.documentation.md [dependabot-skip] * Update src/ansys/mapdl/core/launcher.py --------- Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com> Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com> Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

germa89 added 5 commits October 4, 2024 11:40

feat: adding env vars needed for multinode

ce11a7e

feat: adding env vars needed for multinode

61ad61b

Merge branch 'feat/passing-tight-integration-env-vars-to-MAPDL' of ht…

b50eeb6

…tps://github.com/ansys/pymapdl into feat/passing-tight-integration-env-vars-to-MAPDL

feat: renaming hpc detection argument

e9b91d4

docs: adding documentation

c714d39

germa89 self-assigned this Oct 7, 2024

germa89 mentioned this pull request Oct 7, 2024

docs: another hpc docs reorg #3465

Merged

10 tasks

github-actions bot added documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature labels Oct 7, 2024

chore: adding changelog file 3466.documentation.md

492345b

This was referenced Oct 7, 2024

Document HPC tight integration #3397

Open

[Roadmap] SLURM support #3467

Open

germa89 and others added 8 commits October 7, 2024 12:21

feat: adding env vars needed for multinode

a289dab

feat: renaming hpc detection argument

604bbf8

docs: adding documentation

1d29651

chore: adding changelog file 3466.documentation.md

96929a8

Merge branch 'feat/passing-tight-integration-env-vars-to-MAPDL' of ht…

9b8e0e9

…tps://github.com/ansys/pymapdl into feat/passing-tight-integration-env-vars-to-MAPDL

fix: vale issues

6ab1d65

docs: expanding a bit troubleshooting advices and small format fix

bb2b90a

github-actions bot added CI/CD Related with CICD, Github Actions, etc maintenance General maintenance of the repo (libraries, cicd, etc) labels Oct 7, 2024

germa89 added 3 commits October 7, 2024 14:03

docs: fix vale

330f33c

Merge branch 'feat/passing-tight-integration-env-vars-to-MAPDL' of ht…

26f6dbd

…tps://github.com/ansys/pymapdl into feat/passing-tight-integration-env-vars-to-MAPDL

fix: nproc tests

ac54f2c

koubaa reviewed Oct 7, 2024

View reviewed changes

doc/source/user_guide/hpc/pymapdl.rst Show resolved Hide resolved

koubaa approved these changes Oct 7, 2024

View reviewed changes

feat: adding env vars needed for multinode

6985ee4