Path to local from tapis uri

Author: kks32

dapi/client.py

@@ -183,6 +183,24 @@ def translate_path_to_uri(self, *args, **kwargs) -> str:
         """
         return files_module.get_ds_path_uri(self._tapis, *args, **kwargs)
 
+    def translate_uri_to_path(self, *args, **kwargs) -> str:
+        """Translate Tapis URIs to DesignSafe local paths.
+
+        This is a convenience wrapper around files_module.tapis_uri_to_local_path().
+
+        Args:
+            *args: Positional arguments passed to tapis_uri_to_local_path().
+            **kwargs: Keyword arguments passed to tapis_uri_to_local_path().
+
+        Returns:
+            str: The corresponding DesignSafe local path (e.g., /home/jupyter/MyData/path).
+
+        Example:
+            >>> local_path = client.files.translate_uri_to_path("tapis://designsafe.storage.default/user/data")
+            >>> print(local_path)  # "/home/jupyter/MyData/data"
+        """
+        return files_module.tapis_uri_to_local_path(*args, **kwargs)
+
     def upload(self, *args, **kwargs):
         """Upload a local file to a Tapis storage system.
 

dapi/files.py

@@ -44,6 +44,77 @@ def _parse_tapis_uri(tapis_uri: str) -> (str, str):
         raise ValueError(f"Could not parse Tapis URI '{tapis_uri}': {e}") from e
 
 
+def tapis_uri_to_local_path(tapis_uri: str) -> str:
+    """Convert a Tapis URI to the corresponding DesignSafe local path.
+
+    Converts Tapis system URIs back to their equivalent DesignSafe local paths
+    that would be accessible in a Jupyter environment. This is the reverse
+    operation of get_ds_path_uri().
+
+    Args:
+        tapis_uri (str): The Tapis URI to convert. Supported formats:
+            - "tapis://designsafe.storage.default/username/path" -> "/home/jupyter/MyData/path"
+            - "tapis://designsafe.storage.community/path" -> "/home/jupyter/CommunityData/path"
+            - "tapis://project-*/path" -> "/home/jupyter/MyProjects/path"
+
+    Returns:
+        str: The corresponding DesignSafe local path, or the original URI if
+             it's not a recognized Tapis URI format.
+
+    Raises:
+        ValueError: If the Tapis URI format is invalid.
+
+    Example:
+        >>> local_path = tapis_uri_to_local_path("tapis://designsafe.storage.default/user/data/file.txt")
+        >>> print(local_path)  # "/home/jupyter/MyData/data/file.txt"
+
+        >>> local_path = tapis_uri_to_local_path("tapis://designsafe.storage.community/datasets/earthquake.csv")
+        >>> print(local_path)  # "/home/jupyter/CommunityData/datasets/earthquake.csv"
+    """
+    if not tapis_uri.startswith("tapis://"):
+        # Not a Tapis URI, return as-is
+        return tapis_uri
+
+    try:
+        # Parse the URI using the existing helper function
+        system_id, path = _parse_tapis_uri(tapis_uri)
+
+        # Handle different system types
+        if system_id == "designsafe.storage.default":
+            # For MyData: tapis://designsafe.storage.default/username/path -> /home/jupyter/MyData/path
+            # Remove the username (first path component)
+            path_parts = path.split("/", 1) if path else [""]
+            if len(path_parts) > 1:
+                user_path = path_parts[1]
+                return f"/home/jupyter/MyData/{user_path}"
+            else:
+                return "/home/jupyter/MyData/"
+
+        elif system_id == "designsafe.storage.community":
+            # For CommunityData: tapis://designsafe.storage.community/path -> /home/jupyter/CommunityData/path
+            return (
+                f"/home/jupyter/CommunityData/{path}"
+                if path
+                else "/home/jupyter/CommunityData/"
+            )
+
+        elif system_id.startswith("project-"):
+            # For Projects: tapis://project-*/path -> /home/jupyter/MyProjects/path
+            return (
+                f"/home/jupyter/MyProjects/{path}"
+                if path
+                else "/home/jupyter/MyProjects/"
+            )
+
+        else:
+            # Unknown system type, return original URI
+            return tapis_uri
+
+    except ValueError:
+        # Invalid URI format, return original
+        return tapis_uri
+
+
 def get_ds_path_uri(t: Tapis, path: str, verify_exists: bool = False) -> str:
     """Translate DesignSafe-style paths to Tapis URIs.
 

examples/opensees/OpenSeesMP-dapi.ipynb

@@ -97,12 +97,14 @@
     "# =================================\n",
     "\n",
     "from getpass import getpass\n",
+    "\n",
     "# from tapipy.tapis import Tapis\n",
     "\n",
     "t = Tapis(\n",
-    "  base_url = \"https://designsafe.tapis.io\",\n",
-    "  username = getpass('input username: '),\n",
-    "  password = getpass('input password: '))\n",
+    "    base_url=\"https://designsafe.tapis.io\",\n",
+    "    username=getpass(\"input username: \"),\n",
+    "    password=getpass(\"input password: \"),\n",
+    ")\n",
     "t.get_tokens()"
    ]
   },
@@ -116,11 +118,12 @@
     "import os\n",
     "import uuid\n",
     "from datetime import date\n",
-    "from DS_GenFunctionsV3 import * #General python functions useful for DesignSafe\n",
+    "from DS_GenFunctionsV3 import *  # General python functions useful for DesignSafe\n",
+    "\n",
     "# ---------------------------------------------------------------------------------\n",
     "# Identify folder with input file in DesignSafe\n",
-    "cur_dir        = os.getcwd()\n",
-    "input_uri      = DS_GetDir(cur_dir, t)"
+    "cur_dir = os.getcwd()\n",
+    "input_uri = DS_GetDir(cur_dir, t)"
    ]
   },
   {
@@ -135,28 +138,28 @@
     "\n",
     "# ---------------------------------------------------------------------------------\n",
     "# Select tapis-app\n",
-    "app_id          = \"opensees-mp-s3\"\n",
-    "app_version     = \"3.7.0\"\n",
+    "app_id = \"opensees-mp-s3\"\n",
+    "app_version = \"3.7.0\"\n",
     "\n",
     "# ---------------------------------------------------------------------------------\n",
     "# Define file to run\n",
     "input_filename = \"Main_multiMotion.tcl\"\n",
     "\n",
     "# ---------------------------------------------------------------------------------\n",
     "# Define control tapis-app variables\n",
-    "control_storage_id       = \"designsafe.storage.default\"\n",
-    "control_execSystem       = \"stampede3\" #\"frontera\", \"stampede3-simcenter\"\n",
-    "control_allocation       = \"-A DesignSafe-SimCenter\"  # MUST USE YOUR OWN ALLOCATION !!\n",
-    "control_exec_Dir         = \"DS_input\"  # Folder with files including input_filename\n",
-    "control_nodeCount        = 1\n",
-    "control_corespernode     = 16\n",
-    "control_memoryMB         = 1000\n",
-    "control_maxMinutes       = 60\n",
+    "control_storage_id = \"designsafe.storage.default\"\n",
+    "control_execSystem = \"stampede3\"  # \"frontera\", \"stampede3-simcenter\"\n",
+    "control_allocation = \"-A DesignSafe-SimCenter\"  # MUST USE YOUR OWN ALLOCATION !!\n",
+    "control_exec_Dir = \"DS_input\"  # Folder with files including input_filename\n",
+    "control_nodeCount = 1\n",
+    "control_corespernode = 16\n",
+    "control_memoryMB = 1000\n",
+    "control_maxMinutes = 60\n",
     "\n",
     "if control_execSystem == \"frontera\":\n",
-    "    control_batchQueue = \"development\"  #\"normal\"\n",
-    "elif control_execSystem == \"stampede3\" :\n",
-    "    control_batchQueue = \"skx-dev\"      # \"skx\"\n",
+    "    control_batchQueue = \"development\"  # \"normal\"\n",
+    "elif control_execSystem == \"stampede3\":\n",
+    "    control_batchQueue = \"skx-dev\"  # \"skx\"\n",
     "elif control_execSystem == \"stampede3-simcenter\":\n",
     "    control_batchQueue = \"simcenter\"\n",
     "else:\n",
@@ -171,11 +174,13 @@
    "source": [
     "# -------------------------------------------------------------------------------\n",
     "# Define inputs\n",
-    "fileInputs = [{\"name\": \"Input Directory\", \"sourceUrl\": f\"{input_uri}/{control_exec_Dir}\"}]\n",
+    "fileInputs = [\n",
+    "    {\"name\": \"Input Directory\", \"sourceUrl\": f\"{input_uri}/{control_exec_Dir}\"}\n",
+    "]\n",
     "\n",
     "# -------------------------------------------------------------------------------\n",
     "# Define parameters\n",
-    "parameterSet = {\"appArgs\":[]}\n",
+    "parameterSet = {\"appArgs\": []}\n",
     "parameterSet[\"appArgs\"].append({\"name\": \"Main Script\", \"arg\": input_filename})\n",
     "parameterSet[\"schedulerOptions\"] = [{\"arg\": control_allocation}]"
    ]
@@ -199,7 +204,9 @@
     "job_description[\"execSystemExecDir\"] = \"${JobWorkingDir}\"\n",
     "\n",
     "job_description[\"archiveSystemId\"] = control_storage_id\n",
-    "job_description[\"archiveSystemDir\"] = \"${EffectiveUserId}/tapis-jobs-archive/${JobCreateDate}/${JobUUID}\"\n",
+    "job_description[\n",
+    "    \"archiveSystemDir\"\n",
+    "] = \"${EffectiveUserId}/tapis-jobs-archive/${JobCreateDate}/${JobUUID}\"\n",
     "\n",
     "job_description[\"maxMinutes\"] = control_maxMinutes\n",
     "job_description[\"nodeCount\"] = control_nodeCount\n",
@@ -233,10 +240,12 @@
    "source": [
     "# Submit job\n",
     "job = t.jobs.submitJob(**job_description)\n",
-    "jobUuid=job.uuid\n",
+    "jobUuid = job.uuid\n",
     "\n",
     "print(\" Job launched. Status provided below\")\n",
-    "print(\" Can also check in DedignSafe portal under - Workspace > Tools & Application > Job Status\")"
+    "print(\n",
+    "    \" Can also check in DedignSafe portal under - Workspace > Tools & Application > Job Status\"\n",
+    ")"
    ]
   },
   {
@@ -264,7 +273,7 @@
     }
    ],
    "source": [
-    "#Check status\n",
+    "# Check status\n",
     "status = DS_GetStatus(t, jobUuid, tlapse=1)\n",
     "\n",
     "# Check Runtime\n",
@@ -323,7 +332,7 @@
     }
    ],
    "source": [
-    "os.chdir(jobinfo.archiveSystemDir.replace(user,'/home/jupyter/MyData'))\n",
+    "os.chdir(jobinfo.archiveSystemDir.replace(user, \"/home/jupyter/MyData\"))\n",
     "# os.chdir(control_exec_Dir)\n",
     "os.chdir(\"inputDirectory\")"
    ]
@@ -367,6 +376,7 @@
    "outputs": [],
    "source": [
     "from plotAcc import plot_acc\n",
+    "\n",
     "plot_acc()"
    ]
   }

examples/opensees/OpenSeesMPJupyter-TAPISV3.ipynb

@@ -0,0 +1,67 @@
+import unittest
+from dapi.files import tapis_uri_to_local_path
+
+
+class TestTapisUriToLocalPath(unittest.TestCase):
+    """Test cases for the tapis_uri_to_local_path function"""
+
+    def test_designsafe_storage_default_with_path(self):
+        """Test translation of designsafe.storage.default URIs with paths"""
+        input_uri = "tapis://designsafe.storage.default/kks32/tapis-jobs-archive/2025-06-06Z/80986fb9-0d7e-440a-a4cf-ce54ec26226d-007"
+        expected = "/home/jupyter/MyData/tapis-jobs-archive/2025-06-06Z/80986fb9-0d7e-440a-a4cf-ce54ec26226d-007"
+        result = tapis_uri_to_local_path(input_uri)
+        self.assertEqual(result, expected)
+
+    def test_designsafe_storage_default_simple_path(self):
+        """Test translation of simple designsafe.storage.default URI"""
+        input_uri = "tapis://designsafe.storage.default/user/folder/file.txt"
+        expected = "/home/jupyter/MyData/folder/file.txt"
+        result = tapis_uri_to_local_path(input_uri)
+        self.assertEqual(result, expected)
+
+    def test_designsafe_storage_default_root(self):
+        """Test translation of designsafe.storage.default root URI"""
+        input_uri = "tapis://designsafe.storage.default/kks32/"
+        expected = "/home/jupyter/MyData/"
+        result = tapis_uri_to_local_path(input_uri)
+        self.assertEqual(result, expected)
+
+    def test_designsafe_storage_community(self):
+        """Test translation of designsafe.storage.community URI"""
+        input_uri = "tapis://designsafe.storage.community/datasets/earthquake.csv"
+        expected = "/home/jupyter/CommunityData/datasets/earthquake.csv"
+        result = tapis_uri_to_local_path(input_uri)
+        self.assertEqual(result, expected)
+
+    def test_project_system(self):
+        """Test translation of project system URI"""
+        input_uri = "tapis://project-1234-abcd/analysis/results.txt"
+        expected = "/home/jupyter/MyProjects/analysis/results.txt"
+        result = tapis_uri_to_local_path(input_uri)
+        self.assertEqual(result, expected)
+
+    def test_unknown_system(self):
+        """Test that unknown systems return the original URI"""
+        input_uri = "tapis://unknown-system/path/file.txt"
+        expected = "tapis://unknown-system/path/file.txt"
+        result = tapis_uri_to_local_path(input_uri)
+        self.assertEqual(result, expected)
+
+    def test_non_tapis_uri(self):
+        """Test that non-Tapis URIs are returned unchanged"""
+        input_uri = "/local/path/file.txt"
+        expected = "/local/path/file.txt"
+        result = tapis_uri_to_local_path(input_uri)
+        self.assertEqual(result, expected)
+
+    def test_empty_path(self):
+        """Test handling of URIs with empty paths"""
+        input_uri = "tapis://designsafe.storage.default/user"
+        expected = "/home/jupyter/MyData/"
+        result = tapis_uri_to_local_path(input_uri)
+        self.assertEqual(result, expected)
+
+
+# This allows running the test from the command line
+if __name__ == "__main__":
+    unittest.main()