Skip to content

Get Started

Before you Begin

Before you can use the Skaha python package, you need a valid CANFAR account and access to the CANFAR Science Platform. To request access, please request an account with the Canadian Astronomy Data Centre (CADC).

Quick Start

Skaha Requirements

  • Python 3.8+
  • CANFAR Science Platform Account

Installation

pip3 install skaha

Authentication

Skaha uses a X509 security certificate for interactions with the CANFAR Science Platform. The certificate comes in the form of a .pem file which is saved in your home directory by default under the path ~/.ssl/cadcproxy.pem.

X509 Certificate

You need to have a valid certificate in order to use the CANFAR Science Platform.

Generate a certificate

As part of the skaha package installation, a command line tool named cadc-get-cert is also installed. This tool simplifies the process of generating a certificate by executing the following command:

cadc-get-cert -u username
Password: *******

DONE. 10 day certificate saved in /home/username/.ssl/cadcproxy.pem

By default, skaha only looks at the location $HOME/.ssl/cadcproxy.pem for the X509 authentication certificate. When using the skaha python package, you can specify the location of your certificate when creating a new session.

from skaha.session import Session

session = Session(certificate="/path/to/certificate.pem")

Container Registry Access

In order to access private container images from the CANFAR Harbor Registry, you need to provide a username and the CLI Secret through a ContainerRegistry object.

from skaha.models import ContainerRegistry
from skaha.session import Session

registry = ContainerRegistry(username="username", password="sUp3rS3cr3t")
session = Session(registry=registry)

Passing the ContainerRegistry object passes the base64 encoded username:secret to the Skaha server for authentication under the X-Skaha-Registry-Auth header.