Skip to content

Apps

Application discovery and management for DesignSafe computational applications.

Application Discovery

Search for Tapis apps matching a search term.

Searches through available Tapis applications using partial name matching. This function helps discover applications available for job submission.

PARAMETER DESCRIPTION
t

Authenticated Tapis client instance.

TYPE: Tapis

search_term

Name or partial name to search for. Use empty string for all apps. Supports partial matching with wildcards.

TYPE: str

list_type

Type of apps to list. Must be one of: 'OWNED', 'SHARED_PUBLIC', 'SHARED_DIRECT', 'READ_PERM', 'MINE', 'ALL'. Defaults to "ALL".

TYPE: str DEFAULT: 'ALL'

verbose

If True, prints summary of found apps including ID, version, and owner information. Defaults to True.

TYPE: bool DEFAULT: True

RETURNS DESCRIPTION
List[Tapis]

List[Tapis]: List of matching Tapis app objects with selected fields (id, version, owner).
RAISES DESCRIPTION
AppDiscoveryError

If the Tapis API search fails or an unexpected error occurs during the search operation.
Example

find_apps(client, "matlab", verbose=True) Found 3 matching apps: - matlab-r2023a (Version: 1.0, Owner: designsafe) - matlab-parallel (Version: 2.1, Owner: tacc) - matlab-desktop (Version: 1.5, Owner: designsafe)

Source code in dapi/apps.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def find_apps(
    t: Tapis, search_term: str, list_type: str = "ALL", verbose: bool = True
) -> List[Tapis]:
    """Search for Tapis apps matching a search term.

    Searches through available Tapis applications using partial name matching.
    This function helps discover applications available for job submission.

    Args:
        t (Tapis): Authenticated Tapis client instance.
        search_term (str): Name or partial name to search for. Use empty string
            for all apps. Supports partial matching with wildcards.
        list_type (str, optional): Type of apps to list. Must be one of:
            'OWNED', 'SHARED_PUBLIC', 'SHARED_DIRECT', 'READ_PERM', 'MINE', 'ALL'.
            Defaults to "ALL".
        verbose (bool, optional): If True, prints summary of found apps including
            ID, version, and owner information. Defaults to True.

    Returns:
        List[Tapis]: List of matching Tapis app objects with selected fields
            (id, version, owner).

    Raises:
        AppDiscoveryError: If the Tapis API search fails or an unexpected
            error occurs during the search operation.

    Example:
        >>> find_apps(client, "matlab", verbose=True)
        Found 3 matching apps:
        - matlab-r2023a (Version: 1.0, Owner: designsafe)
        - matlab-parallel (Version: 2.1, Owner: tacc)
        - matlab-desktop (Version: 1.5, Owner: designsafe)
    """
    try:
        # Use id.like for partial matching, ensure search term is handled
        search_query = f"(id.like.*{search_term}*)" if search_term else None
        results = t.apps.getApps(
            search=search_query, listType=list_type, select="id,version,owner"
        )  # Select fewer fields for speed

        if verbose:
            if not results:
                print(
                    f"No apps found matching '{search_term}' with listType '{list_type}'"
                )
            else:
                print(f"\nFound {len(results)} matching apps:")
                for app in results:
                    print(f"- {app.id} (Version: {app.version}, Owner: {app.owner})")
                print()
        return results
    except BaseTapyException as e:
        raise AppDiscoveryError(
            f"Failed to search for apps matching '{search_term}': {e}"
        ) from e
    except Exception as e:
        raise AppDiscoveryError(
            f"An unexpected error occurred while searching for apps: {e}"
        ) from e

Application Details

Get detailed information for a specific app ID and version.

Retrieves comprehensive details about a specific Tapis application, including job attributes, execution system, and parameter definitions.

PARAMETER DESCRIPTION
t

Authenticated Tapis client instance.

TYPE: Tapis

app_id

Exact app ID to look up. Must match exactly.

TYPE: str

app_version

Specific app version to retrieve. If None, fetches the latest available version. Defaults to None.

TYPE: Optional[str] DEFAULT: None

verbose

If True, prints basic app information including ID, version, owner, execution system, and description. Defaults to True.

TYPE: bool DEFAULT: True

RETURNS DESCRIPTION
Optional[Tapis]

Optional[Tapis]: Tapis app object with full details including jobAttributes, parameterSet, and other configuration. Returns None if the app is not found.
RAISES DESCRIPTION
AppDiscoveryError

If the Tapis API call fails (except for 404 not found) or an unexpected error occurs during retrieval.
Example

app = get_app_details(client, "matlab-r2023a", "1.0") App Details: ID: matlab-r2023a Version: 1.0 Owner: designsafe Execution System: frontera Description: MATLAB R2023a runtime environment

Source code in dapi/apps.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def get_app_details(
    t: Tapis, app_id: str, app_version: Optional[str] = None, verbose: bool = True
) -> Optional[Tapis]:
    """Get detailed information for a specific app ID and version.

    Retrieves comprehensive details about a specific Tapis application,
    including job attributes, execution system, and parameter definitions.

    Args:
        t (Tapis): Authenticated Tapis client instance.
        app_id (str): Exact app ID to look up. Must match exactly.
        app_version (Optional[str], optional): Specific app version to retrieve.
            If None, fetches the latest available version. Defaults to None.
        verbose (bool, optional): If True, prints basic app information including
            ID, version, owner, execution system, and description. Defaults to True.

    Returns:
        Optional[Tapis]: Tapis app object with full details including jobAttributes,
            parameterSet, and other configuration. Returns None if the app is not found.

    Raises:
        AppDiscoveryError: If the Tapis API call fails (except for 404 not found)
            or an unexpected error occurs during retrieval.

    Example:
        >>> app = get_app_details(client, "matlab-r2023a", "1.0")
        App Details:
          ID: matlab-r2023a
          Version: 1.0
          Owner: designsafe
          Execution System: frontera
          Description: MATLAB R2023a runtime environment
    """
    try:
        if app_version:
            app_info = t.apps.getApp(appId=app_id, appVersion=app_version)
        else:
            app_info = t.apps.getAppLatestVersion(appId=app_id)

        if verbose:
            print(f"\nApp Details:")
            print(f"  ID: {app_info.id}")
            print(f"  Version: {app_info.version}")
            print(f"  Owner: {app_info.owner}")
            if hasattr(app_info, "jobAttributes") and hasattr(
                app_info.jobAttributes, "execSystemId"
            ):
                print(f"  Execution System: {app_info.jobAttributes.execSystemId}")
            else:
                print("  Execution System: Not specified in jobAttributes")
            print(f"  Description: {app_info.description}")
        return app_info
    except BaseTapyException as e:
        # Check for 404 specifically
        if hasattr(e, "response") and e.response and e.response.status_code == 404:
            print(f"App '{app_id}' (Version: {app_version or 'latest'}) not found.")
            # Optionally, try searching for similar apps
            # print("\nAttempting to find similar apps:")
            # find_apps(t, app_id, verbose=True)
            return None
        else:
            print(
                f"Error getting app info for '{app_id}' (Version: {app_version or 'latest'}): {e}"
            )
            raise AppDiscoveryError(
                f"Failed to get details for app '{app_id}': {e}"
            ) from e
    except Exception as e:
        print(f"An unexpected error occurred getting app info for '{app_id}': {e}")
        raise AppDiscoveryError(
            f"Unexpected error getting details for app '{app_id}': {e}"
        ) from e