Rename commands for brevity

Author: kks32

dapi/client.py

@@ -169,11 +169,9 @@ def __init__(self, tapis_client: Tapis):
         """
         self._tapis = tapis_client
 
-    def translate_path_to_uri(self, *args, **kwargs) -> str:
+    def to_uri(self, *args, **kwargs) -> str:
         """Translate DesignSafe-style paths to Tapis URIs.
 
-        This is a convenience wrapper around files_module.get_ds_path_uri().
-
         Args:
             *args: Positional arguments passed to get_ds_path_uri().
             **kwargs: Keyword arguments passed to get_ds_path_uri().
@@ -187,11 +185,9 @@ 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:
+    def 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().
@@ -200,7 +196,7 @@ def translate_uri_to_path(self, *args, **kwargs) -> str:
             str: The corresponding DesignSafe local path (e.g., /home/jupyter/MyData/path).
 
         Example:
-            >>> local_path = ds.files.translate_uri_to_path("tapis://designsafe.storage.default/user/data")
+            >>> local_path = ds.files.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)
@@ -270,7 +266,7 @@ def __init__(self, tapis_client: Tapis):
         """
         self._tapis = tapis_client
 
-    def list_queues(self, system_id: str, verbose: bool = True) -> List[Any]:
+    def queues(self, system_id: str, verbose: bool = True) -> List[Any]:
         """List logical queues available on a Tapis execution system.
 
         This is a convenience wrapper around systems_module.list_system_queues().
@@ -379,7 +375,7 @@ def __init__(self, tapis_client):
 
     def generate(
         self,
-        base_command: str,
+        command: str,
         sweep: Dict[str, Any],
         directory: str = None,
         *,
@@ -392,12 +388,12 @@ def generate(
         With ``preview=True``, returns a DataFrame of all parameter
         combinations — no files are written.
 
-        Otherwise, expands *base_command* into one command per combination
+        Otherwise, expands *command* into one command per combination
         and writes ``runsList.txt`` and ``call_pylauncher.py`` into
         *directory*. Returns the list of generated commands.
 
         Args:
-            base_command: Command template with placeholders matching sweep keys.
+            command: Command template with placeholders matching sweep keys.
             sweep: Mapping of placeholder name to sequence of values.
             directory: Directory to write files into (created if needed).
                 Required when *preview* is ``False``.
@@ -411,7 +407,7 @@ def generate(
             *preview* is ``True``.
         """
         return launcher_module.generate_sweep(
-            base_command, sweep, directory,
+            command, sweep, directory,
             placeholder_style=placeholder_style, debug=debug, preview=preview,
         )
 
@@ -617,23 +613,22 @@ def submit(self, job_request: Dict[str, Any]) -> SubmittedJob:
         """
         return jobs_module.submit_job_request(self._tapis, job_request)
 
-    # --- Management methods remain the same ---
-    def get(self, job_uuid: str) -> SubmittedJob:
-        """Get a SubmittedJob object for managing an existing job by UUID.
+    def job(self, job_uuid: str) -> SubmittedJob:
+        """Get a SubmittedJob object for an existing job by UUID.
 
         Args:
             job_uuid (str): The UUID of an existing Tapis job.
 
         Returns:
-            SubmittedJob: A SubmittedJob object for monitoring and managing the job.
+            SubmittedJob: A job object for monitoring via ``.monitor()``.
 
         Example:
-            >>> job = ds.jobs.get("12345678-1234-1234-1234-123456789abc")
-            >>> status = job.status
+            >>> job = ds.jobs.job("12345678-1234-1234-1234-123456789abc")
+            >>> job.monitor()
         """
         return SubmittedJob(self._tapis, job_uuid)
 
-    def get_status(self, job_uuid: str) -> str:
+    def status(self, job_uuid: str) -> str:
         """Get the current status of a job by UUID.
 
         Args:
@@ -646,12 +641,12 @@ def get_status(self, job_uuid: str) -> str:
             JobMonitorError: If status retrieval fails.
 
         Example:
-            >>> status = ds.jobs.get_status("12345678-1234-1234-1234-123456789abc")
-            >>> print(f"Job status: {status}")
+            >>> ds.jobs.status("12345678-1234-1234-1234-123456789abc")
+            'FINISHED'
         """
         return jobs_module.get_job_status(self._tapis, job_uuid)
 
-    def get_runtime_summary(self, job_uuid: str, verbose: bool = False):
+    def runtime_summary(self, job_uuid: str, verbose: bool = False):
         """Print the runtime summary for a job by UUID.
 
         Args:
@@ -660,7 +655,7 @@ def get_runtime_summary(self, job_uuid: str, verbose: bool = False):
                 Defaults to False.
 
         Example:
-            >>> ds.jobs.get_runtime_summary("12345678-1234-1234-1234-123456789abc")
+            >>> ds.jobs.runtime_summary("12345678-1234-1234-1234-123456789abc")
             Runtime Summary
             ---------------
             QUEUED  time: 00:05:30

dapi/exceptions.py

@@ -109,7 +109,7 @@ class SystemInfoError(DapiException):
 
     Example:
         >>> try:
-        ...     queues = client.systems.list_queues("nonexistent-system")
+        ...     queues = client.systems.queues("nonexistent-system")
         ... except SystemInfoError as e:
         ...     print(f"System info retrieval failed: {e}")
     """

dapi/launcher.py

@@ -27,13 +27,13 @@ def _validate_sweep(sweep: Mapping[str, Sequence[Any]]) -> None:
 
 
 def _expand_commands(
-    base_command: str,
+    command: str,
     sweep: Mapping[str, Sequence[Any]],
     placeholder_style: str,
 ) -> List[str]:
     """Expand a command template into all parameter combinations."""
     if not sweep:
-        return [base_command]
+        return [command]
 
     _validate_sweep(sweep)
 
@@ -43,7 +43,7 @@ def _expand_commands(
     keys = list(sweep.keys())
     commands: List[str] = []
     for combo in product(*[sweep[k] for k in keys]):
-        cmd = base_command
+        cmd = command
         for k, v in zip(keys, combo):
             if placeholder_style == "token":
                 cmd = cmd.replace(k, str(v))
@@ -55,7 +55,7 @@ def _expand_commands(
 
 
 def generate_sweep(
-    base_command: str,
+    command: str,
     sweep: Mapping[str, Sequence[Any]],
     directory: Union[str, Path, None] = None,
     *,
@@ -69,19 +69,19 @@ def generate_sweep(
     combinations without writing any files — useful for inspecting the
     sweep in a notebook before committing.
 
-    When *preview* is ``False`` (default), expands *base_command* into one
+    When *preview* is ``False`` (default), expands *command* into one
     command per parameter combination and writes ``runsList.txt`` and
     ``call_pylauncher.py`` into *directory*.
 
     Args:
-        base_command: Command template containing placeholders that match
+        command: Command template containing placeholders that match
             keys in *sweep*. Environment variables like ``$WORK`` or
             ``$SLURM_JOB_ID`` are left untouched.
         sweep: Mapping of placeholder name to a sequence of values.
             Example: ``{"ALPHA": [0.3, 0.5], "BETA": [1, 2]}``.
         directory: Directory to write files into. Created if it doesn't
             exist. Required when *preview* is ``False``.
-        placeholder_style: How placeholders appear in *base_command*:
+        placeholder_style: How placeholders appear in *command*:
 
             - ``"token"`` (default): bare tokens, e.g. ``ALPHA``
             - ``"braces"``: brace-wrapped, e.g. ``{ALPHA}``
@@ -113,7 +113,7 @@ def generate_sweep(
     if directory is None:
         raise ValueError("directory is required when preview=False.")
 
-    commands = _expand_commands(base_command, sweep, placeholder_style)
+    commands = _expand_commands(command, sweep, placeholder_style)
 
     dirpath = Path(directory)
     dirpath.mkdir(parents=True, exist_ok=True)

docs/examples/mpm.md

@@ -88,7 +88,7 @@ mpm_config = {
 
 ```python
 # Convert DesignSafe path to Tapis URI format
-input_uri = ds.files.translate_path_to_uri(ds_path)
+input_uri = ds.files.to_uri(ds_path)
 print(f"Input Directory Tapis URI: {input_uri}")
 ```
 
@@ -232,7 +232,7 @@ ds.jobs.interpret_status(final_status, submitted_job.uuid)
 submitted_job.print_runtime_summary(verbose=False)
 
 # Get current job status
-current_status = ds.jobs.get_status(submitted_job.uuid)
+current_status = ds.jobs.status(submitted_job.uuid)
 print(f"Current status: {current_status}")
 
 # Display last status message from TACC
@@ -243,7 +243,7 @@ print(f"Last message: {submitted_job.last_message}")
 
 - **`interpret_status`**: Provides human-readable explanation of job outcome
 - **`print_runtime_summary`**: Shows time spent in each job phase (queued, running, etc.)
-- **`get_status`**: Gets current job status (useful for checking later)
+- **`status`**: Gets current job status (useful for checking later)
 - **`last_message`**: Shows last status message from the job scheduler
 
 ### Step 10: View Job Output
@@ -307,7 +307,7 @@ typical_outputs = {
 
 ```python
 # Convert archive URI to local path for analysis
-archive_path = ds.files.translate_uri_to_path(archive_uri)
+archive_path = ds.files.to_path(archive_uri)
 print(f"Archive path: {archive_path}")
 
 # Import analysis libraries
@@ -333,7 +333,7 @@ else:
 
 **What this does:**
 
-- **`translate_uri_to_path`**: Converts Tapis URI to local file system path
+- **`to_path`**: Converts Tapis URI to local file system path
 - **`os.listdir`**: Lists files in the results directory
 - **`.vtu files`**: VTK unstructured grid files for visualization
 - **ParaView**: Recommended tool for visualizing MPM particle data

docs/examples/openfoam.md

@@ -90,7 +90,7 @@ solvers = {
 
 ```python
 # Convert DesignSafe path to Tapis URI format
-input_uri = ds.files.translate_path_to_uri(ds_path)
+input_uri = ds.files.to_uri(ds_path)
 print(f"Input Directory Tapis URI: {input_uri}")
 ```
 
@@ -239,7 +239,7 @@ ds.jobs.interpret_status(final_status, submitted_job.uuid)
 submitted_job.print_runtime_summary(verbose=False)
 
 # Get current job status
-current_status = ds.jobs.get_status(submitted_job.uuid)
+current_status = ds.jobs.status(submitted_job.uuid)
 print(f"Current status: {current_status}")
 
 # Display last status message from TACC
@@ -250,7 +250,7 @@ print(f"Last message: {submitted_job.last_message}")
 
 - **`interpret_status`**: Provides human-readable explanation of job outcome
 - **`print_runtime_summary`**: Shows time spent in each job phase (queued, running, etc.)
-- **`get_status`**: Gets current job status (useful for checking later)
+- **`status`**: Gets current job status (useful for checking later)
 - **`last_message`**: Shows last status message from the job scheduler
 
 ### Step 10: View Job Output
@@ -302,7 +302,7 @@ typical_outputs = {
 
 ```python
 # Convert archive URI to local path for analysis
-archive_path = ds.files.translate_uri_to_path(archive_uri)
+archive_path = ds.files.to_path(archive_uri)
 print(f"Archive path: {archive_path}")
 
 # Import plotting libraries
@@ -322,7 +322,7 @@ print(f"Loaded force coefficients data with shape: {data.shape}")
 
 **What this does:**
 
-- **`translate_uri_to_path`**: Converts Tapis URI to local file system path
+- **`to_path`**: Converts Tapis URI to local file system path
 - **`pandas.read_csv`**: Reads force coefficient data (much cleaner than manual parsing)
 - **`skiprows=9`**: Skips OpenFOAM header lines
 - **`sep='\t'`**: Uses tab separator (OpenFOAM default)

docs/examples/opensees.md

@@ -80,7 +80,7 @@ control_corespernode: int = 16 # Cores per node for parallel analysis
 
 ```python
 # Convert DesignSafe path to Tapis URI format
-input_uri = ds.files.translate_path_to_uri(ds_path)
+input_uri = ds.files.to_uri(ds_path)
 print(f"Input Directory Tapis URI: {input_uri}")
 ```
 
@@ -225,7 +225,7 @@ ds.jobs.interpret_status(final_status, submitted_job.uuid)
 submitted_job.print_runtime_summary(verbose=False)
 
 # Get current job status
-current_status = ds.jobs.get_status(submitted_job.uuid)
+current_status = ds.jobs.status(submitted_job.uuid)
 print(f"Current status: {current_status}")
 
 # Display last status message from TACC
@@ -236,7 +236,7 @@ print(f"Last message: {submitted_job.last_message}")
 
 - **`interpret_status`**: Provides human-readable explanation of job outcome
 - **`print_runtime_summary`**: Shows time spent in each job phase (queued, running, etc.)
-- **`get_status`**: Gets current job status (useful for checking later)
+- **`status`**: Gets current job status (useful for checking later)
 - **`last_message`**: Shows last status message from the job scheduler
 
 ### Step 10: Access Job Archive and Results
@@ -247,7 +247,7 @@ archive_uri = submitted_job.archive_uri
 print(f"Archive URI: {archive_uri}")
 
 # Translate archive URI to local DesignSafe path
-local_archive_path = ds.files.translate_uri_to_path(archive_uri)
+local_archive_path = ds.files.to_path(archive_uri)
 print(f"Local archive path: {local_archive_path}")
 
 # List archive contents
@@ -260,7 +260,7 @@ for item in archive_files:
 **What this does:**
 
 - **`archive_uri`**: Location where job results are stored
-- **`translate_uri_to_path`**: Converts Tapis URI to local path for analysis
+- **`to_path`**: Converts Tapis URI to local path for analysis
 - **`ds.files.list`**: Lists all files and directories in the archive
 - Shows output files like analysis results, output data, and logs
 
@@ -290,7 +290,7 @@ try:
  print(f"- {item.name} ({item.type})")
 
  # Change to the archive directory for post-processing
- archive_path = ds.files.translate_uri_to_path(input_dir_archive_uri)
+ archive_path = ds.files.to_path(input_dir_archive_uri)
  os.chdir(archive_path)
  print(f"\nChanged to directory: {archive_path}")
 

docs/jobs.md

@@ -108,7 +108,7 @@ print(f"Default Cores: {app_details.jobAttributes.coresPerNode}")
 ```python
 # 1. Prepare input directory
 input_path = "/MyData/analysis/input/"
-input_uri = ds.files.translate_path_to_uri(input_path, verify_exists=True)
+input_uri = ds.files.to_uri(input_path, verify_exists=True)
 
 # 2. Generate job request
 job_request = ds.jobs.generate(
@@ -403,7 +403,7 @@ for job in jobs:
 
 ```python
 # List available queues for a system
-frontera_queues = ds.systems.list_queues("frontera")
+frontera_queues = ds.systems.queues("frontera")
 for queue in frontera_queues:
  print(f"Queue: {queue.name}")
  print(f"Max runtime: {queue.maxRequestedTime} minutes")
@@ -419,7 +419,7 @@ print(f"Development queue available: {dev_queue_exists}")
 ```python
 # Get system information
 try:
- queues = ds.systems.list_queues("stampede3")
+ queues = ds.systems.queues("stampede3")
  print(f"Stampede3 has {len(queues)} available queues")
 except Exception as e:
  print(f"Cannot access Stampede3: {e}")