Apps

dapi.apps.find_apps(t, search_term, list_type='ALL', verbose=True)[source]

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.

Parameters:

  • 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 of matching Tapis app objects with selected fields

(id, version, owner).

Return type:

List[Tapis]

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)
dapi.apps.get_app_details(t, app_id, app_version=None, verbose=True)[source]

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.

Parameters:

  • 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:

Tapis app object with full details including jobAttributes,

parameterSet, and other configuration. Returns None if the app is not found.

Return type:

Optional[Tapis]

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