Add script to run interrupt command

examples/mapdl_tyre_performance/exec_mapdl.py

@@ -0,0 +1,89 @@
+# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Basic execution script for MAPDL.
+
+Command formed: ansys.exe -b -i <inp_file> -o <out_file> -np 4
+
+"""
+import os
+import subprocess
+
+from ansys.rep.common.logging import log
+from ansys.rep.evaluator.task_manager import ApplicationExecution
+
+
+class MAPDLExecution(ApplicationExecution):
+    class Meta(ApplicationExecution.Meta):
+        available_commands = ["interrupt", "command_with_parameters"]
+
+    def execute(self):
+
+        log.info("Start of MAPDL execution script.")
+
+        # Identify files
+        inp_file = next((f for f in self.context.input_files if f["name"] == "inp"), None)
+        assert inp_file, "Input file inp missing"
+        out_file = next((f for f in self.context.output_files if f["name"] == "out"), None)
+        assert out_file, "Output file out missing"
+
+        # Identify application
+        app_name = "Ansys Mechanical APDL"
+        app = next((a for a in self.context.software if a["name"] == app_name), None)
+        assert app, f"Cannot find app {app_name}"
+
+        # Add " around exe if needed for Windows
+        exe = app["executable"]
+        if " " in exe and not exe.startswith('"'):
+            exe = '"%s"' % exe
+
+        # Use properties from resource requirements
+        num_cores = self.context.resource_requirements["num_cores"]
+
+        # Pass env vars correctly
+        env = dict(os.environ)
+        env.update(self.context.environment)
+
+        # Form command
+        cmd = f"{exe} -b -i {inp_file['path']} -o {out_file['path']} -np {num_cores}"
+
+        # Execute command
+        log.info(f"Executing: {cmd}")
+        subprocess.run(cmd, shell=True, check=True, env=env)
+
+        log.info("End of MAPDL execution script.")
+
+    def interrupt(self):
+        log.info("Interrupting MAPDL.")
+        with open("file.abt", "w") as file:
+            file.write("nonlinear")
+        log.info("Created file.abt.")
+
+    def command_with_parameters(self, count: int, message: str):
+        if not count or count < 0:
+            raise Exception("count must be greater than zero")
+
+        message = os.path.expandvars(message)
+        while count:
+            log.info(f"{count}: {message}")
+            count -= 1

examples/mapdl_tyre_performance/interrupt_task.py

@@ -0,0 +1,126 @@
+# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Example to submit a nonlinear tire analysis job to HPS.
+
+This is the Ansys Parametric Design Language (APDL) Tire Performance Simulation example included
+in the technology demonstration guide (td-57).
+"""
+
+import argparse
+import logging
+import time
+
+from ansys.hps.client import Client, HPSError
+from ansys.hps.client.jms import JmsApi, Project, ProjectApi
+
+log = logging.getLogger(__name__)
+
+
+def interrupt_running_task(client, project_id) -> Project:
+    jms_api = JmsApi(client)
+    proj = jms_api.get_project(project_id)
+
+    project_api = ProjectApi(client, proj.id)
+
+    task_def = project_api.get_task_definitions()[0]
+
+    running_tasks = project_api.get_tasks(
+        {"task_definition_id": task_def.id, "eval_status": "running"}
+    )
+    if not running_tasks:
+        log.error("No tasks are running.")
+
+    task = running_tasks[0]
+    if not task.eval_status == "running":
+        log.error("Task is not running.")
+        return
+
+    log.info(f"Found running Task: {task.id}")
+
+    project_url = f"{client.url}/jms/api/v1/projects/{project_id}"
+    command_defs_url = f"{project_url}/task_command_definitions"
+
+    resp = client.session.get(command_defs_url)
+    command_defs = resp.json()["task_command_definitions"]
+    if not command_defs:
+        log.error(f"No command definitions found")
+        return
+
+    cmd_def = None
+    for cmd in command_defs:
+        if cmd['name'] == 'interrupt':
+            cmd_def = cmd
+
+    if not cmd_def:
+        log.error(f"Interrupt command not found")
+
+    log.info(f"Command definition id: {cmd_def['id']}")
+
+    command_url = f"{project_url}/task_commands"
+    data_str = f"""{{"task_commands" :
+    [
+        {{"task_id": "{task.id}",
+        "command_definition_id": "{cmd_def["id"]}",
+        "arguments": {{}}}}
+    ]}}"""
+    log.debug(data_str)
+
+    resp = client.session.post(command_url, data=data_str)
+    if not resp.status_code == 201:
+        log.info("Failed to submit task command.")
+        return
+
+    cmd = resp.json()["task_commands"][0]
+    while not cmd["status"] == "executed" and not cmd["status"] == "failed":
+        resp = client.session.get(command_url, params={"id": cmd["id"]})
+        if not resp.status_code == 200:
+            log.info("Failed to check task command status.")
+        cmd = resp.json()["task_commands"][0]
+        log.info(f"Command status: {cmd['status']}")
+        time.sleep(0.5)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-U", "--url", default="https://localhost:8443/hps")
+    parser.add_argument("-u", "--username", default="repuser")
+    parser.add_argument("-p", "--password", default="repuser")
+    parser.add_argument("-P", "--project", required=True)
+
+    args = parser.parse_args()
+
+    logger = logging.getLogger()
+    logging.basicConfig(format="[%(asctime)s | %(levelname)s] %(message)s", level=logging.DEBUG)
+
+    log.debug("=== HPS connection")
+    client = Client(url=args.url, username=args.username, password=args.password)
+
+    try:
+        log.info(f"HPS URL: {client.url}")
+        interrupt_running_task(
+            client=client,
+            project_id=args.project,
+        )
+    except HPSError as e:
+        log.error(str(e))