PyHPS Data Transfer

Overview

PyHPS Data Transfer is a Python client library for the Ansys HPC Platform Services (HPS) data transfer service.

Installation

You can use pip to install PyHPS Data Transfer in user mode:

pip install ansys-hps-data-transfer-client

To install the latest development version from the GitHub repository, run these commands:

git clone https://github.com/ansys/pyhps-data-transfer/
cd pyhps-data-transfer
pip install -e .

For more information, see Getting started.

Basic usage

The following sections show how to import PyHPS Data Transfer and use some basic capabilities.

Request access token

The client library requires an access token to connect to the HPS Data Transfer service.

from ansys.hps.data_transfer.client.authenticate import authenticate

auth_url = "https://localhost:8443/hps/auth/realms/rep"

token = authenticate(username="repadmin", password="repadmin", verify=False, url=auth_url)
token = token.get("access_token", None)

Connect to data transfer service client

After obtaining the access token, you can connect to the data transfer service client:

from ansys.hps.data_transfer.client import Client    # Import the Client class
dt_url = f"https://localhost:8443/hps/dt/api/v1"
client = Client()   # Create a client object
client.binary_config.update(verbosity=3, debug=True, insecure=True, token=token, data_transfer_url=dt_url, log=True)
client.start()

api = DataTransferApi(client)
api.status(wait=True)

For comprehensive usage information, see Examples.

Documentation and issues

Documentation for the latest stable release of PyHPS Data Transfer is hosted at PyHPS Data Transfer documentation.

In the upper right corner of the documentation's title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

On the PyHPS Data Transfer Issues page, you can create issues to report bugs and request new features. On the PyHPS Data Transfer Discussions page or the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email [email protected].