mpsd-software-environment.py

@@ -471,6 +471,61 @@ def prepare_environment(mpsd_release: str, script_dir: Path) -> List[str]:
     return available_toolchains
 
 
+def get_native_microarchitecture():
+    """Return native microarchitecture.
+
+    On MPSD machines, there should be an environment variable "MPSD_MICROARCH".
+    We try to read that. If it fails, we use the 'archspec cpu' command.
+    If that fails, we ask the user to install it.
+
+    Returns
+    -------
+    MPSD_MICROARCH : str
+
+    Example
+    -------
+    >>> get_native_microarchitecture()
+    'haswell'
+    """
+    # attempt to get MICRO_ARCH from environment variable (should work on
+    # MPSD_HPC and MPSD linux laptops). If not defined, return
+    # "UNKNOWN_MICROARCH"
+    microarch = os.environ.get("MPSD_MICROARCH", "UNKNOWN_MICROARCH")
+
+    # if we have not found the microarchitecture environment variable,
+    # try calling archspec
+    if microarch == "UNKNOWN_MICROARCH":
+        logging.debug(
+            "Couldn't find MPSD_MICROARCH environment variable. Will try archspec."
+        )
+        try:
+            process = run(["archspec", "cpu"], stdout=subprocess.PIPE, text=True)
+        except FileNotFoundError as e:
+            logging.debug(f"Call of 'archspec cpu' failed: {e=}")
+            # Presumably 'archspec' is not installed.
+            msg = "Please install archspec, for example via 'pipx install archspec'.\n"
+            msg += "The command we need to execute is 'archspec cpu'.\n"
+            msg += "Documentation of package: https://archspec.readthedocs.io/"
+
+            logging.error(msg)
+            sys.exit(1)
+        else:  # we have found archspec and executed it
+            if process.returncode == 0:  # sanity check
+                microarch = process.stdout.strip()
+                logging.debug(
+                    f"Found microarchitecture from 'archspec cpu' to be '{microarch}'"
+                )
+                assert len(microarch) > 0  # sanity check
+            else:
+                raise ValueError(
+                    f"Some error occurred when calling 'archspec cpu': {process=}"
+                )
+
+    # at this point, we have determined the microarchitecture
+    log_metadata("microarchitecture", microarch)
+    return microarch
+
+
 def install_environment(
     mpsd_release: str,
     toolchains: List[str],
@@ -541,9 +596,10 @@ def install_environment(
 
     for toolchain in toolchains:
         if toolchain not in available_toolchains:
-            raise ValueError(
-                f"Toolchain '{toolchain}' is not available in release {mpsd_release}."
-            )
+            # TODO: add to message how toolchains can be found
+            msg = f"Toolchain '{toolchain}' is not available in release {mpsd_release}."
+            logging.error(msg)
+            sys.exit(1)
 
     # Install the toolchains
     with os_chdir(toolchain_dir):

tests.py

@@ -361,3 +361,7 @@ def test_interface(tmp_path):
     # check that the help message is printed when no arguments are provided
     # check that the help message is printed when -h is provided
     # check that the error messages are also logged to the log file
+
+
+# other tests to add (ideally)
+# - get_native_microarchitecture()