Images API

The Image API allows you to get information about the publicly available images on the CANFAR Science Platform through the CANFAR Harbor Registry. It can be used to get information about all images, or filter by a specific image kind.

Getting Image Information

Get image information

from skaha.images import Images

images = Images()
images.fetch()
[
    "images.canfar.net/canfar/base-3.12:v0.4.1",
    "images.canfar.net/canucs/test:1.2.5",
    "images.canfar.net/canucs/canucs:1.2.9",
    ...,
]

But most of the time, you are only interested in images of a particular type. For example, if you want to get all the images that are available for headless sessions, you can do the following:

Get headless image information

images.fetch(kind="headless")

Python

[
    "images.canfar.net/chimefrb/testing:keep",
    "images.canfar.net/lsst/lsst_v19_0_0:0.1",
    "images.canfar.net/skaha/lensfit:22.11",
    "images.canfar.net/skaha/lensfit:22.10",
    "images.canfar.net/skaha/lensingsim:22.07",
    "images.canfar.net/skaha/phosim:5.6.11",
    "images.canfar.net/skaha/terminal:1.1.2",
    "images.canfar.net/skaha/terminal:1.1.1",
    "images.canfar.net/uvickbos/pycharm:0.1",
    "images.canfar.net/uvickbos/swarp:0.1",
    "images.canfar.net/uvickbos/isis:2.2",
    "images.canfar.net/uvickbos/find_moving:0.1",
]

API Reference

Bases: SkahaClient

Skaha Image Management.

Parameters:

Name	Type	Description	Default
SkahaClient	SkahaClient	Configured Skaha Client.	required

Returns:

Name	Type	Description
Images		Skaha Image Management Object.

fetch

Python

fetch(kind: Optional[str] = None) -> List[str]

Get images from Skaha Server.

Parameters:

Name	Type	Description	Default
kind	Optional[str]	Type of image. Defaults to None.	None

Returns:

Type	Description
List[str]	List[str]: A list of images on the skaha server.

Examples:

Python Console Session

>>> from skaha.images import Images
>>> images = Images()
>>> images.fetch(kind="headless")
['images.canfar.net/chimefrb/sample:latest',
 ...
 'images.canfar.net/skaha/terminal:1.1.1']

Source code in skaha/images.py

Python

def fetch(self, kind: Optional[str] = None) -> List[str]:
    """Get images from Skaha Server.

    Args:
        kind (Optional[str], optional): Type of image. Defaults to None.

    Returns:
        List[str]: A list of images on the skaha server.

    Examples:
        >>> from skaha.images import Images
        >>> images = Images()
        >>> images.fetch(kind="headless")
        ['images.canfar.net/chimefrb/sample:latest',
         ...
         'images.canfar.net/skaha/terminal:1.1.1']
    """
    data: Dict[str, str] = {}
    # If kind is not None, add it to the data dictionary
    if kind:
        data["type"] = kind
    response: Response = self.client.get("image", params=data)  # type: ignore # noqa
    response.raise_for_status()
    payload: Dict[str, Any] = response.json()
    reply: List[str] = []
    for image in payload:
        reply.append(image["id"])  # type: ignore
    return reply