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.

Sign up for GitHub

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

Jump to bottom

docs: documenting using pymapdl on clusters #3466

Merged
merged 43 commits into from
Oct 23, 2024
Merged

docs: documenting using pymapdl on clusters #3466

merged 43 commits into from
Oct 23, 2024

Conversation

germa89
Copy link
Collaborator

@germa89 germa89 commented Oct 7, 2024 •
edited
Loading

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

@germa89 germa89 self-assigned this Oct 7, 2024
@ansys-reviewer-bot
Copy link
Contributor

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

@ansys-reviewer-bot review

@germa89 germa89 mentioned this pull request Oct 7, 2024
Merged
10 tasks
@github-actions github-actions bot added documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature labels Oct 7, 2024
This was referenced Oct 7, 2024
Open
Open
germa89 and others added 8 commits October 7, 2024 12:21
@germa89
feat: adding env vars needed for multinode
a289dab
@germa89
feat: renaming hpc detection argument
604bbf8
@germa89
docs: adding documentation
1d29651
@pyansys-ci-bot @germa89
chore: adding changelog file 3466.documentation.md
96929a8
@germa89
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
@germa89
fix: vale issues
6ab1d65
@germa89
chore: To fix sphinx build
e45d2e5 
Squashed commit of the following:

commit c1d1a3e
Author: German <[email protected]>
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 <[email protected]>
Date:   Mon Oct 7 15:31:24 2024 +0200

    fix: add suggestions

    Co-authored-by: German <[email protected]>

commit 575a219
Merge: f2afe13 be1be2e
Author: Revathyvenugopal162 <[email protected]>
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 <[email protected]>
Date:   Mon Oct 7 15:08:58 2024 +0200

    fix: precommit

commit be1be2e
Author: pyansys-ci-bot <[email protected]>
Date:   Mon Oct 7 13:07:35 2024 +0000

    chore: adding changelog file 3468.fixed.md

commit f052a4d
Author: Revathyvenugopal162 <[email protected]>
Date:   Mon Oct 7 15:05:56 2024 +0200

    fix: add build cheatsheet as env variable within doc-build
@germa89
docs: expanding a bit troubleshooting advices and small format fix
bb2b90a
@github-actions 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
Copy link
Collaborator Author

germa89 commented Oct 7, 2024

Screenshots

PyMAPDL on HPC Clusters

image

Troubleshooting

image

PipKat
PipKat approved these changes Oct 23, 2024
View reviewed changes
Copy link
Member

@PipKat PipKat left a comment

Choose a reason for hiding this comment

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

Mostly edits to make the content meet Ansys style guidelines.

@germa89
Copy link
Collaborator Author

germa89 commented Oct 23, 2024

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

@germa89 germa89 merged commit d71c544 into maint/main_copy Oct 23, 2024
27 checks passed
@germa89 germa89 deleted the feat/passing-tight-integration-env-vars-to-MAPDL branch October 23, 2024 16:11
@germa89 germa89 mentioned this pull request Oct 23, 2024
Merged
10 tasks
germa89 added a commit that referenced this pull request Oct 23, 2024
@germa89 @pyansys-ci-bot
@clatapie @PipKat
docs: review of documenting using pymapdl on clusters (#3466) (#3506)
c0fa797 
* 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 <[email protected]>
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 <[email protected]>
Date:   Mon Oct 7 15:31:24 2024 +0200

    fix: add suggestions

    Co-authored-by: German <[email protected]>

commit 575a219
Merge: f2afe13 be1be2e
Author: Revathyvenugopal162 <[email protected]>
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 <[email protected]>
Date:   Mon Oct 7 15:08:58 2024 +0200

    fix: precommit

commit be1be2e
Author: pyansys-ci-bot <[email protected]>
Date:   Mon Oct 7 13:07:35 2024 +0000

    chore: adding changelog file 3468.fixed.md

commit f052a4d
Author: Revathyvenugopal162 <[email protected]>
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 <[email protected]>

* docs: apply suggestions from code review made by Kathy

Co-authored-by: Kathy Pippert <[email protected]>

* docs: adding Kathy suggestion.

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Camille <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>

* chore: adding changelog file 3506.documentation.md [dependabot-skip]

* Update src/ansys/mapdl/core/launcher.py

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Camille <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@koubaa koubaa koubaa approved these changes

@clatapie clatapie clatapie approved these changes

@PipKat PipKat PipKat approved these changes

@pyansys-ci-bot pyansys-ci-bot Awaiting requested review from pyansys-ci-bot pyansys-ci-bot is a code owner automatically assigned from ansys/pymapdl-maintainers

Assignees

@germa89 germa89

Labels
documentation Documentation related (improving, adding, etc) new feature Request or proposal for a new feature waiting doc review This PR is waiting for its documentation to be reviewed.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@germa89 @koubaa @clatapie @PipKat @pyansys-ci-bot