Extend examples to include execution script parameter handling

examples/mapdl_motorbike_frame/exec_mapdl.py

@@ -51,7 +51,7 @@ def execute(self):
         # Add " around exe if needed for Windows
         exe = app["executable"]
         if " " in exe and not exe.startswith('"'):
-            exe = '"%s"' % exe  # noqa
+            exe = f'"{exe}"'  # noqa
 
         # Use properties from resource requirements
         num_cores = self.context.resource_requirements["num_cores"]

examples/python_large_output/exec_python.py

@@ -49,7 +49,7 @@ def execute(self):
         # Add " around exe if needed for Windows
         exe = app["executable"]
         if " " in exe and not exe.startswith('"'):
-            exe = '"%s"' % exe  # noqa
+            exe = f'"{exe}"'  # noqa
 
         # Use properties from resource requirements
         # None currently

examples/python_multi_process_step/eval.py

@@ -161,6 +161,8 @@ def text(i, txt):
             f"{task_definition}",
             "--in-subscript",
         ]
+        if "images":
+            cmd.append("--images")
         log.info("Run Subscript with: {cmd}")
         subprocess.run(cmd, check=False)
 

examples/python_multi_process_step/project_setup.py

@@ -24,22 +24,20 @@
 
 Author(s): R.Walker
 
-Run *python eval.py --help* for command line arguments.
+Run *python project_setup.py --help* for command line arguments.
 
 The project id is generated as
-"py_{NUM_PROCESS_STEPS}_ps" and the `_img` is appended if result image is written.
-
-Per default the project is inactive. You can activate the project with the `-a` flag
+"Python - {NUM_PROCESS_STEPS} Task Defs (- Img )- Sequential/Parallel"
 
 
 Example:
 -------
 ```
-python project_setup.py -n 100 -c 10 --no-images
+python project_setup.py -n 100 -c 10
 ```
-Create 100 design points
+Create 100 design points with the default 3 tasks each
   and change the first 10 design points
-  and do not write an result image.
+  and do not write a result image.
 
 """
 
@@ -235,7 +233,7 @@ def main(
                     Software(name="Python", version=python_version),
                 ],
                 execution_command=cmd,
-                max_execution_time=duration * 1.5,
+                max_execution_time=duration * 1.5 + 12.0,
                 resource_requirements=ResourceRequirements(
                     num_cores=0.2,
                     memory=100 * 1024 * 1024,  # 100 MB
@@ -280,7 +278,7 @@ def main(
     # change dp task files
     if change_job_tasks > 0:
         log.info(f"Change tasks for {change_job_tasks} jobs")
-        update_task_files(proj, change_job_tasks, images)
+        update_task_files(project_api, change_job_tasks, images)
 
     log.info(f"Created project '{proj.name}', ID='{proj.id}'")
 

examples/python_multi_process_step/task_files.py

@@ -54,7 +54,8 @@ def update_input_file(task):
 
 
 def update_eval_script(task):
-    path = "eval.py"
+    cwd = os.path.dirname(__file__)
+    path = os.path.join(cwd, "eval.py")
     lines = open(path).readlines()
 
     log.info(f"Update input file {path} for task {task.task_definition_snapshot.name}")
@@ -82,14 +83,21 @@ def update_eval_script(task):
 def update_task_files(project_api, num_jobs, write_images):
     log.debug("=== Update Task files ===")
 
-    config = project_api.get_job_definitions()[0]
-    jobs = config.get_jobs(limit=num_jobs)
+    jobs = project_api.get_jobs(limit=num_jobs)
+
+    # Stop the jobs we're about to change
+    for job in jobs:
+        job["eval_status"] = "inactive"
+    project_api.update_jobs(jobs)
+    for job in jobs:
+        job["eval_status"] = "pending"
 
     for dp in jobs:
         log.debug(f" Update job {dp.name}")
         dp.name = dp.name + " Modified"
-        tasks = dp.get_tasks()
-        for i, task in enumerate(tasks, 1):
+        tasks = project_api.get_tasks()
+        tasks_sel = [t for t in tasks if t.job_id == dp.id]
+        for i, task in enumerate(tasks_sel):
             files = []
             # input_file
             ##input_name = "ps_{}_input".format(i)
@@ -99,18 +107,18 @@ def update_task_files(project_api, num_jobs, write_images):
             ##                src=os.path.join(cwd, "input.json".format(i)) ) )
             # new input_file will be used by subprocess
             new_input_file = update_input_file(task)
-            new_input_name = f"sub_td_{i}_input"
+            new_input_name = f"sub_td{i}_input"
             files.append(
                 File(
                     name=new_input_name,
-                    evaluation_path=f"sub_td_{i}_input.json",
+                    evaluation_path=f"sub_td{i}_input.json",
                     type="application/json",
                     src=new_input_file,
                 )
             )
             # overwrite the eval script: same name --> will be overwritten
             new_eval_script = update_eval_script(task)
-            new_eval_name = f"td_{i}_pyscript"
+            new_eval_name = f"td{i}_pyscript"
             files.append(
                 File(
                     name=new_eval_name,
@@ -126,23 +134,23 @@ def update_task_files(project_api, num_jobs, write_images):
             #                collect=True, monitor=True,
             #                type="text/plain" ) )
             # new output text
-            new_out_name = f"sub_td_{i}_results"
+            new_out_name = f"sub_td{i}_results"
             files.append(
                 File(
                     name=new_out_name,
-                    evaluation_path=f"sub_td_{i}_results.txt",
+                    evaluation_path=f"sub_td{i}_results.txt",
                     collect=True,
                     monitor=True,
                     type="text/plain",
                 )
             )
             # new image
             if write_images:
-                new_image_name = f"sub_td_{i}_results_jpg"
+                new_image_name = f"sub_td{i}_results_jpg"
                 files.append(
                     File(
                         name=new_image_name,
-                        evaluation_path=f"sub_td_{i}_results.jpg",
+                        evaluation_path=f"sub_td{i}_results.jpg",
                         type="image/jpeg",
                         collect=True,
                     )
@@ -158,7 +166,7 @@ def update_task_files(project_api, num_jobs, write_images):
             task.output_file_ids = output_file_ids
             task.input_file_ids = [file_ids[new_input_name], file_ids[new_eval_name]]
 
-        project_api.update_tasks(tasks)
+        project_api.update_tasks(tasks_sel)
 
     project_api.update_jobs(jobs)
     log.info(f"Updated {len(jobs)} design points")

examples/python_two_bar_truss_params_in_exec_script/evaluate.py

@@ -0,0 +1,92 @@
+# Copyright (C) 2022 - 2025 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.
+
+# ruff: noqa
+
+import json
+import math
+import os
+import sys
+
+
+def weight(P, d, t, B, H, rho, E):
+    w = 2 * math.pi * rho * d * t * math.sqrt((0.5 * B) ** 2 + H**2)
+    return w
+
+
+def stress(P, d, t, B, H, rho, E):
+    s = P * math.sqrt((0.5 * B) ** 2 + H**2) / (2 * t * math.pi * d * H)
+    return s / 1000  # psi to ksi
+
+
+def buckling_stress(P, d, t, B, H, rho, E):
+    b = math.pi**2 * E * (d**2 + t**2) / (8 * ((0.5 * B) ** 2 + H**2))
+    return b / 1000  # psi to ksi
+
+
+def deflection(P, d, t, B, H, rho, E):
+    f = P * math.pow((0.5 * B) ** 2 + H**2, 3 / 2) / (2 * t * math.pi * d * H**2 * E)
+    return f
+
+
+def filter_params(params):
+    for key in ["weight", "stress", "buckling_stress", "deflection"]:
+        params.pop(key)
+
+
+def rename_params(params):
+    param_name_to_label = {
+        "height": "H",
+        "diameter": "d",
+        "thickness": "t",
+        "separation_distance": "B",
+        "young_modulus": "E",
+        "density": "rho",
+        "load": "P",
+    }
+    for key in param_name_to_label.keys():
+        params[param_name_to_label[key]] = params.pop(key)
+
+
+def main():
+    # Load, filter and rename parameters
+    input_file_name = sys.argv[1]
+    input_file_path = os.path.abspath(input_file_name)
+    with open(input_file_path) as input_file:
+        params = json.load(input_file)
+    filter_params(params)
+    rename_params(params)
+
+    # Calculate results
+    output_parameters = {}
+    output_parameters.update(weight=weight(**params))
+    output_parameters.update(stress=stress(**params))
+    output_parameters.update(buckling_stress=buckling_stress(**params))
+    output_parameters.update(deflection=deflection(**params))
+
+    # Output results
+    with open("output_parameters.json", "w") as out_file:
+        json.dump(output_parameters, out_file, indent=4)
+
+
+if __name__ == "__main__":
+    main()

examples/python_two_bar_truss_params_in_exec_script/exec_python.py

@@ -0,0 +1,82 @@
+# Copyright (C) 2022 - 2025 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.
+
+"""Simplistic execution script for Python.
+
+Command formed: python <script_file> <input_file>
+"""
+
+import json
+import os
+
+from ansys.rep.common.logging import log
+from ansys.rep.evaluator.task_manager import ApplicationExecution
+
+
+class PythonExecution(ApplicationExecution):
+    def execute(self):
+        log.info("Start Python execution script")
+
+        # Identify files
+        script_file = next((f for f in self.context.input_files if f["name"] == "script"), None)
+        assert script_file, "Python script file script missing"
+        input_filename = "input_parameters.json"
+        output_filename = "output_parameters.json"
+
+        with open(input_filename, "w") as in_file:
+            json.dump(self.context.parameter_values, in_file, indent=4)
+
+        # Identify application
+        app_name = "Python"
+        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 = f'"{exe}"'  # noqa
+
+        # Use properties from resource requirements
+        # None currently
+
+        # Pass env vars correctly
+        env = dict(os.environ)
+        env.update(self.context.environment)
+
+        # Form command
+        cmd = f"{exe} {script_file['path']} {input_filename}"
+
+        log.debug(f"Executing command: {cmd}")
+        # Execute
+        self.run_and_capture_output(cmd, shell=True, env=env)
+
+        # Extract parameters if needed
+        try:
+            log.debug(f"Loading output parameters from {output_filename}")
+            with open(output_filename) as out_file:
+                output_parameters = json.load(out_file)
+            self.context.parameter_values.update(output_parameters)
+            log.debug(f"Loaded output parameters: {output_parameters}")
+        except Exception as ex:
+            log.error(f"Failed to read output_parameters from file: {ex}")
+
+        log.info("End Python execution script")