feat: adding support to launch MAPDL on remote HPC clusters

[germa89]

...

HIGHLY UNDER DEVELOPMENT!!

Description

As the title.

Close #3562

Notes

• Consider to return two objects, Mapdl and job (object to query/manage the HPC job status)
• Sanitaze the input parameters. https://app.deepsource.com/directory/analyzers/python/issues/BAN-B601

Example

from ansys.mapdl.core.hpc import launch_on_remote_hpc
import os

from ansys.mapdl.core import LOG

LOG.setLevel("DEBUG")
LOG.log_to_file("mylog.log")

mapdl = launch_on_remote_hpc(
    hostname="myhostname",
    username="user",
    password="mypass",
    exec_file="/ansys_inc/v242/ansys/bin/ansys242",
    run_location="/home/user/simulation",
    # loglevel="DEBUG",
    scheduler_options={"partition": "partition"},
    replace_env_vars={"ANSYS_LOCK": "OFF"},
    nproc=2, # required
    )

mapdl.input("apdl.inp")

print(mapdl.jobid)

print(mapdl.prep7())

mapdl.exit()

print("Ended")

Issue linked

NA

Checklist

• I have visited and read Develop PyMAPDL.
• I have tested my changes locally
• I have added necessary documentation or updated existing documentation.
• I have followed the PyMAPDL coding style guidelines.
• I have added appropriate unit tests that also ensure the minimal coverage criteria.
• I have reviewed my changes before submitting this pull request.
• I have linked the issue or issues that are solved to the PR if any.
• I have assigned this PR to myself.
• I have marked this PR as draft if it is not ready to be reviewed yet.
• I have made sure that the title of my PR follows Commit naming conventions (e.g. feat: adding new MAPDL command)

[ansys-reviewer-bot]

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

@ansys-reviewer-bot review

[codecov]

Codecov Report

Attention: Patch coverage is 97.63780% with 3 lines in your changes missing coverage. Please review.

Project coverage is 88.35%. Comparing base (e515e96) to head (86fc801).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3713      +/-   ##
==========================================
+ Coverage   88.28%   88.35%   +0.07%     
==========================================
  Files         187      188       +1     
  Lines       14704    14817     +113     
==========================================
+ Hits        12981    13092     +111     
- Misses       1723     1725       +2     

[germa89]

Regarding:

Consider to return two objects, Mapdl and job (object to query/manage the HPC job status)

Whereas I agree with the concern of Mapdl class doing too much, I feel like a class just handling the job (job class), might be a bit of a trouble at the moment because we will have to implement everything from scratch just for the sole purpose of exposing the job status, and job stop methods. And the status is not actually needed per see, and the stop is already executed within mapdl.exit.