ansys-mechanical-core 0.10.10__py3-none-any.whl → 0.11.12__py3-none-any.whl

ansys/mechanical/core/embedding/shims.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -25,16 +25,17 @@
 These shims are used when APIs are released in newer versions of Mechanical,
 but workarounds exist in an older release
 """
+import warnings
 
 
 def import_materials(
     app: "ansys.mechanical.core.embedding.Application", material_file: str
 ) -> None:
     """Import material from matml file."""
-    if app._version >= 232:
-        materials = app.DataModel.Project.Model.Materials
-        materials.Import(material_file)
-    else:  # pragma: no cover
-        material_file = material_file.replace("\\", "\\\\")
-        script = 'DS.Tree.Projects.Item(1).LoadEngrDataLibraryFromFile("' + material_file + '");'
-        app.ExtAPI.Application.ScriptByName("jscript").ExecuteCommand(script)
+    warnings.warn(
+        "Use of this function is deprecated. Use Model.Materials.Import() directly.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    materials = app.DataModel.Project.Model.Materials
+    materials.Import(material_file)

ansys/mechanical/core/embedding/ui.py

@@ -0,0 +1,228 @@
+# 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.
+"""Run Mechanical UI from Python."""
+
+from pathlib import Path
+
+# Subprocess is needed to launch the GUI and clean up the process on close.
+# Excluding bandit check.
+from subprocess import Popen  # nosec: B404
+import sys
+import tempfile
+import typing
+
+
+class UILauncher:
+    """Launch the GUI using a temporary mechdb file."""
+
+    def __init__(self, dry_run: bool = False):
+        """Initialize UILauncher class."""
+        self._dry_run = dry_run
+
+    def save_original(self, app: "ansys.mechanical.core.embedding.App") -> None:
+        """Save the active mechdb file.
+
+        Parameters
+        ----------
+        app: ansys.mechanical.core.embedding.app.App
+            A Mechanical embedding application.
+        """
+        app.save()
+
+    def save_temp_copy(
+        self, app: "ansys.mechanical.core.embedding.App"
+    ) -> typing.Union[Path, Path]:
+        """Save a new mechdb file with a temporary name.
+
+        Parameters
+        ----------
+        app: ansys.mechanical.core.embedding.app.App
+            A Mechanical embedding application.
+        """
+        # Identify the mechdb of the saved session from save_original()
+        project_directory = Path(app.project_directory)
+        project_directory_parent = project_directory.parent
+        mechdb_file = (
+            project_directory_parent / f"{project_directory.parts[-1].split('_')[0]}.mechdb"
+        )
+
+        # Get name of NamedTemporaryFile
+        temp_file_name = tempfile.NamedTemporaryFile(
+            dir=project_directory_parent, suffix=".mechdb", delete=True
+        ).name
+
+        # Save app with name of temporary file
+        app.save_as(temp_file_name)
+
+        return mechdb_file, temp_file_name
+
+    def open_original(self, app: "ansys.mechanical.core.embedding.App", mechdb_file: str) -> None:
+        """Open the original mechdb file from save_original().
+
+        Parameters
+        ----------
+        app: ansys.mechanical.core.embedding.app.App
+            A Mechanical embedding application.
+        mechdb_file: str
+            The full path to the active mechdb file.
+        """
+        app.open(mechdb_file)
+
+    def graphically_launch_temp(
+        self, app: "ansys.mechanical.core.embedding.App", temp_file: Path
+    ) -> typing.Union[Popen, str]:
+        """Launch the GUI for the mechdb file with a temporary name from save_temp_copy().
+
+        Parameters
+        ----------
+        app: ansys.mechanical.core.embedding.app.App
+            A Mechanical embedding application.
+        temp_file: pathlib.Path
+            The full path to the temporary mechdb file.
+
+        Returns
+        -------
+        subprocess.Popen
+            The subprocess that launches the GUI for the temporary mechdb file.
+        """
+        # The ansys-mechanical command to launch the GUI in a subprocess
+        args = [
+            "ansys-mechanical",
+            "--project-file",
+            temp_file,
+            "--graphical",
+            "--revision",
+            str(app.version),
+        ]
+        if not self._dry_run:
+            # The subprocess that uses ansys-mechanical to launch the GUI of the temporary
+            # mechdb file
+            process = Popen(args)  # nosec: B603 # pragma: no cover
+            return process
+        else:
+            # Return a string containing the args
+            return " ".join(args)
+
+    def _cleanup_gui(self, process: Popen, temp_mechdb_path: Path) -> None:
+        """Remove the temporary mechdb file and folder when the GUI is closed.
+
+        Parameters
+        ----------
+        process: subprocess.Popen
+            The subprocess that launched the GUI of the temporary mechdb file.
+        temp_mechdb_path: pathlib.Path
+            The full path to the temporary mechdb file.
+        """
+        # Get the path to the cleanup script
+        cleanup_script = Path(__file__).parent / "cleanup_gui.py"  # pragma: no cover
+
+        if not self._dry_run:
+            # Open a subprocess to remove the temporary mechdb file and folder when the process ends
+            Popen(
+                [sys.executable, cleanup_script, str(process.pid), temp_mechdb_path]
+            )  # pragma: no cover # nosec: B603
+
+
+def _is_saved(app: "ansys.mechanical.core.embedding.App") -> bool:
+    """Check if the mechdb file has been saved and raise an exception if not.
+
+    Parameters
+    ----------
+    app: ansys.mechanical.core.embedding.app.App
+        A Mechanical embedding application.
+
+    Returns
+    -------
+    bool
+        ``True`` when the embedded app has been saved.
+        ``False`` when the embedded app has not been saved.
+    """
+    try:
+        app.save()
+    except:
+        raise Exception("The App must have already been saved before using launch_ui!")
+    return True
+
+
+def _launch_ui(
+    app: "ansys.mechanical.core.embedding.App", delete_tmp_on_close: bool, launcher: UILauncher
+) -> None:
+    """Launch the Mechanical UI if the mechdb file has been saved.
+
+    Parameters
+    ----------
+    app: ansys.mechanical.core.embedding.app.App
+        A Mechanical embedding application.
+    delete_tmp_on_close: bool
+        Whether to delete the temporary mechdb file when the GUI is closed.
+        By default, this is ``True``.
+    launcher: UILauncher
+        Launch the GUI using a temporary mechdb file.
+    """
+    if _is_saved(app):
+        # Save the active mechdb file.
+        launcher.save_original(app)
+        # Save a new mechdb file with a temporary name.
+        mechdb_file, temp_file = launcher.save_temp_copy(app)
+        # Open the original mechdb file from save_original().
+        launcher.open_original(app, str(mechdb_file))
+        # Launch the GUI for the mechdb file with a temporary name from save_temp_copy().
+        process = launcher.graphically_launch_temp(app, temp_file)
+
+        # If it's a dry run and graphically_launch_temp returned a string, print the string
+        if isinstance(process, str):
+            print(process)
+
+        # If the user wants the temporary file to be deleted and graphically_launch_temp
+        # returned a process. By default, this is True
+        if delete_tmp_on_close and not isinstance(process, str):
+            # Remove the temporary mechdb file and folder when the GUI is closed.
+            launcher._cleanup_gui(process, temp_file)  # pragma: no cover
+        else:
+            # Let the user know that the mechdb started above will not automatically get cleaned up
+            print(
+                f"""Opened a new mechanical session based on {mechdb_file} named {temp_file}.
+PyMechanical will not delete it after use."""
+            )
+
+
+def launch_ui(
+    app: "ansys.mechanical.core.embedding.App",
+    delete_tmp_on_close: bool = True,
+    dry_run: bool = False,
+) -> None:
+    """Launch the Mechanical UI.
+
+    Precondition: Mechanical has to have already been saved
+    Side effect: If Mechanical has ever been saved, it overwrites that save.
+
+    Parameters
+    ----------
+    app: ansys.mechanical.core.embedding.app.App
+        A Mechanical embedding application.
+    delete_tmp_on_close: bool
+        Whether to delete the temporary mechdb file when the GUI is closed.
+        By default, this is ``True``.
+    dry_run: bool
+        Whether or not to launch the GUI. By default, this is ``False``.
+    """
+    _launch_ui(app, delete_tmp_on_close, UILauncher(dry_run))

ansys/mechanical/core/embedding/utils.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/mechanical/core/embedding/viz/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/mechanical/core/embedding/viz/{pyvista_plotter.py → embedding_plotter.py}

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -29,6 +29,7 @@ clr.AddReference("Ansys.ACT.Interfaces")
 
 import Ansys  # isort: skip
 
+from ansys.tools.visualization_interface import Plotter
 import numpy as np
 import pyvista as pv
 
@@ -44,7 +45,7 @@ def _transform_to_pyvista(transform: "Ansys.ACT.Math.Matrix4D"):
     return np_transform
 
 
-def _get_nodes_and_coords(tri_tessellation: "Ansys.Mechanical.Scenegraph.TriTessellationNode"):
+def _get_tri_nodes_and_coords(tri_tessellation: "Ansys.Mechanical.Scenegraph.TriTessellationNode"):
     """Get the nodes and indices of the TriTessellationNode.
 
     pyvista format expects a number of vertices per facet which is always 3
@@ -55,18 +56,33 @@ def _get_nodes_and_coords(tri_tessellation: "Ansys.Mechanical.Scenegraph.TriTess
     return np_coordinates, np_indices
 
 
-def plot_model(app):
-    """Plot the model."""
-    plotter = pv.Plotter()
+def _get_nodes_and_coords(node: "Ansys.Mechanical.Scenegraph.Node"):
+    """Get the nodes and indices of the Scenegraph node.
 
+    Currently only supported for tri tessellation nodes
+    """
+    if isinstance(node, Ansys.Mechanical.Scenegraph.TriTessellationNode):
+        return _get_tri_nodes_and_coords(node)
+
+    # TODO - support line tessellation node. See issue #809
+    # if isinstance(node, Ansys.Mechanical.Scenegraph.LineTessellationNode):
+    return None, None
+
+
+def to_plotter(app: "ansys.mechanical.core.embedding.App"):
+    """Convert the app's geometry to an ``ansys.tools.visualization_interface.Plotter`` instance."""
+    plotter = Plotter()
+
+    # TODO - use get_scene from utils instead of looping over bodies directly here.
     for body in app.DataModel.GetObjectsByType(
         Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory.Body
     ):
         scenegraph_node = Ansys.ACT.Mechanical.Tools.ScenegraphHelpers.GetScenegraph(body)
         np_coordinates, np_indices = _get_nodes_and_coords(scenegraph_node.Child)
+        if np_coordinates is None or np_indices is None:
+            continue
         pv_transform = _transform_to_pyvista(scenegraph_node.Transform)
         polydata = pv.PolyData(np_coordinates, np_indices).transform(pv_transform)
         color = pv.Color(bgr_to_rgb_tuple(body.Color))
-        plotter.add_mesh(polydata, color=color, smooth_shading=True)
-
-    plotter.show()
+        plotter.plot(polydata, color=color, smooth_shading=True)
+    return plotter

ansys/mechanical/core/embedding/viz/usd_converter.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -24,15 +24,9 @@
 
 import typing
 
-import clr
 from pxr import Gf, Usd, UsdGeom
 
-clr.AddReference("Ansys.Mechanical.DataModel")
-clr.AddReference("Ansys.ACT.Interfaces")
-
-import Ansys  # isort: skip
-
-from .utils import bgr_to_rgb_tuple, get_nodes_and_coords
+from .utils import bgr_to_rgb_tuple, get_nodes_and_coords, get_scene
 
 
 def _transform_to_rotation_translation(
@@ -73,37 +67,77 @@ def _convert_tri_tessellation_node(
     return mesh_prim
 
 
-def _convert_transform_node(
-    node: "Ansys.Mechanical.Scenegraph.TransformNode",
-    stage: Usd.Stage,
-    path: str,
-    rgb: typing.Tuple[int, int, int],
+def _create_prim_with_transform(
+    stage: Usd.Stage, path: str, node: "Ansys.Mechanical.Scenegraph.TransformNode"
 ) -> Usd.Prim:
-    """Convert a mechanical transform node into a Usd Xform prim."""
+    """Create an empty Usd Xform prim based on a mechanical transform node."""
     prim = UsdGeom.Xform.Define(stage, path)
     rotation, translation = _transform_to_rotation_translation(node.Transform)
     prim.AddOrientOp().Set(rotation)
     prim.AddTranslateOp().Set(translation)
+    return prim
+
+
+def _convert_transform_node(
+    node: "Ansys.Mechanical.Scenegraph.TransformNode",
+    stage: Usd.Stage,
+    path: str,
+    rgb: typing.Tuple[int, int, int],
+) -> None:
+    """Add a Usd prim to the stage based on the given mechanical transform node.
+
+    Currently only supports transforms that contain a single tri tessellation node.
+    """
+    import clr
+
+    clr.AddReference("Ansys.Mechanical.DataModel")
+    clr.AddReference("Ansys.ACT.Interfaces")
+
+    import Ansys  # isort: skip
+
     child_node = node.Child
-    child_path = prim.GetPath().AppendPath("TriTessellation")
     if isinstance(child_node, Ansys.Mechanical.Scenegraph.TriTessellationNode):
+        prim = _create_prim_with_transform(stage, path, node)
+        child_path = prim.GetPath().AppendPath("TriTessellation")
         _convert_tri_tessellation_node(child_node, stage, child_path, rgb)
-    return prim
 
 
-def to_usd_stage(app: "ansys.mechanical.core.embedding.App", name: str) -> None:
-    """Convert mechanical scene to usd stage."""
-    stage = Usd.Stage.CreateNew(name)
+def _convert_attribute_node(
+    node: "Ansys.Mechanical.Scenegraph.AttributeNode",
+    stage: Usd.Stage,
+    path: str,
+) -> None:
+    """Add a Usd Prim of the child node with the given attributes node.
+
+    Currently only supports color attributes.
+    """
+    import clr
 
+    clr.AddReference("Ansys.Mechanical.DataModel")
+    clr.AddReference("Ansys.ACT.Interfaces")
+
+    import Ansys  # isort: skip
+
+    child_node = node.Child
+    color = node.Property(Ansys.Mechanical.Scenegraph.ScenegraphIntAttributes.Color)
+    _convert_transform_node(child_node, stage, path, bgr_to_rgb_tuple(color))
+
+
+def load_into_usd_stage(scene: "Ansys.Mechanical.Scenegraph.GroupNode", stage: Usd.Stage) -> None:
+    """Load mechanical scene into usd stage `stage`."""
     root_prim = UsdGeom.Xform.Define(stage, "/root")
 
-    category = Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory.Body
-    bodies = app.DataModel.GetObjectsByType(category)
-    for body in bodies:
-        scenegraph_node = Ansys.ACT.Mechanical.Tools.ScenegraphHelpers.GetScenegraph(body)
-        body_path = root_prim.GetPath().AppendPath(f"body{body.ObjectId}")
-        _convert_transform_node(scenegraph_node, stage, body_path, bgr_to_rgb_tuple(body.Color))
+    for child in scene.Children:
+        child: "Ansys.Mechanical.Scenegraph.AttributeNode" = child
+        child_path = root_prim.GetPath().AppendPath(child.Tag)
+        _convert_attribute_node(child, stage, child_path)
+
 
+def to_usd_stage(app: "ansys.mechanical.core.embedding.App", name: str) -> Usd.Stage:
+    """Convert mechanical scene to new usd stage and return it."""
+    stage = Usd.Stage.CreateNew(name)
+    scene = get_scene(app)
+    load_into_usd_stage(scene, stage)
     return stage
 
 

ansys/mechanical/core/embedding/viz/utils.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -41,7 +41,8 @@ def _reshape_3cols(arr: np.array, name: str = "array"):
     """
     err = f"{name} must be of the form (x0,y0,z0,x1,y1,z1,...,xn,yn,zn).\
         Given {name} are not divisible by 3!"
-    assert arr.size % 3 == 0, err
+    if arr.size % 3 != 0:
+        raise ValueError(err)
     numrows = int(arr.size / 3)
     numcols = 3
     arr = np.reshape(arr, (numrows, numcols))
@@ -59,3 +60,32 @@ def get_nodes_and_coords(tri_tessellation: "Ansys.Mechanical.Scenegraph.TriTesse
     )
     np_indices = _reshape_3cols(np.array(tri_tessellation.Indices, dtype=np.int32), "indices")
     return np_coordinates, np_indices
+
+
+def get_scene(
+    app: "ansys.mechanical.core.embedding.App",
+) -> "Ansys.Mechanical.Scenegraph.GroupNode":
+    """Get the scene of the model."""
+    import clr
+
+    clr.AddReference("Ansys.Mechanical.DataModel")
+    clr.AddReference("Ansys.Mechanical.Scenegraph")
+    clr.AddReference("Ansys.ACT.Interfaces")
+
+    import Ansys  # isort: skip
+
+    category = Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory.Body
+    group_node = Ansys.Mechanical.Scenegraph.Builders.GroupNodeBuilder()
+    for body in app.DataModel.GetObjectsByType(category):
+        scenegraph_node = Ansys.ACT.Mechanical.Tools.ScenegraphHelpers.GetScenegraph(body)
+        # wrap the body node in an attribute node using the body color
+        attribute_node_builder = Ansys.Mechanical.Scenegraph.Builders.AttributeNodeBuilder()
+        attribute_node = (
+            attribute_node_builder.Tag(f"body{body.ObjectId}")
+            .Child(scenegraph_node)
+            # set the color, body.Color is a BGR uint bitfield
+            .Property(Ansys.Mechanical.Scenegraph.ScenegraphIntAttributes.Color, body.Color)
+            .Build()
+        )
+        group_node.AddChild(attribute_node)
+    return group_node.Build()

ansys/mechanical/core/embedding/warnings.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/mechanical/core/errors.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -31,6 +31,7 @@ from grpc._channel import _InactiveRpcError, _MultiThreadedRendezvous
 from ansys.mechanical.core import LOG as logger
 
 SIGINT_TRACKER = []
+"""List of SIGINT keyboard interrupts."""
 
 
 class VersionError(ValueError):

ansys/mechanical/core/examples/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

ansys/mechanical/core/examples/downloads.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022 - 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #
@@ -26,7 +26,8 @@ import os
 import shutil
 from typing import Optional
 from urllib.parse import urljoin
-import urllib.request
+
+import requests
 
 import ansys.mechanical.core as pymechanical
 
@@ -53,9 +54,13 @@ def _get_filepath_on_default_server(filename: str, *directory: str):
         return joiner(server, filename)
 
 
-def _retrieve_url(url, dest):
-    saved_file, _ = urllib.request.urlretrieve(url, filename=dest)
-    return saved_file
+def _retrieve_url(url: str, dest: str) -> str:
+    with requests.get(url, stream=True, timeout=10) as r:
+        r.raise_for_status()
+        with open(dest, "wb") as f:
+            for chunk in r.iter_content(chunk_size=4096):
+                f.write(chunk)
+    return dest
 
 
 def _retrieve_data(url: str, filename: str, dest: str = None, force: bool = False):

ansys/mechanical/core/feature_flags.py

@@ -0,0 +1,51 @@
+# 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.
+
+"""Mechanical beta feature flags."""
+
+import typing
+import warnings
+
+
+class FeatureFlags:
+    """Supported feature flag names."""
+
+    ThermalShells = "Mechanical.ThermalShells"
+    MultistageHarmonic = "Mechanical.MultistageHarmonic"
+
+
+def get_feature_flag_names() -> typing.List[str]:
+    """Get the available feature flags."""
+    return [x for x in dir(FeatureFlags) if "_" not in x]
+
+
+def _get_flag_arg(flagname: str) -> str:
+    """Get the command line name for a given feature flag."""
+    if hasattr(FeatureFlags, flagname):
+        return getattr(FeatureFlags, flagname)
+    warnings.warn(f"Using undocumented feature flag {flagname}")
+    return flagname
+
+
+def get_command_line_arguments(flags: typing.List[str]):
+    """Get the command line arguments as an array for the given flags."""
+    return ["-featureflags", ";".join([_get_flag_arg(flag) for flag in flags])]