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-clientTo 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 pyansys.core@ansys.com.
1 maintainer
Metadata
1 maintainer
Release files for ansys-hps-data-transfer-client 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ansys_hps_data_transfer_client-0.5.0.tar.gz | 29.9 kB | With provenance | Details for ansys_hps_data_transfer_client-0.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ansys_hps_data_transfer_client-0.5.0-py3-none-any.whl | Python 3 | none | any | Details for ansys_hps_data_transfer_client-0.5.0-py3-none-any.whl |
Total release size: 74.9 kB
Release files / ansys_hps_data_transfer_client-0.5.0.tar.gz
| Download URL | ansys_hps_data_transfer_client-0.5.0.tar.gz |
|---|---|
| Size | 29.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b38a3120017793c7c0e0f3305e130c395a997461bd8b58b34ef205e294cd82df
|
|
BLAKE2b-256 checksum How to use checksums |
6561737deba539d76d95b5875022d48c49fec3f64845565d07da638409b5ccff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 31, 2026.
Transparency logRelease files / ansys_hps_data_transfer_client-0.5.0-py3-none-any.whl
| Download URL | ansys_hps_data_transfer_client-0.5.0-py3-none-any.whl |
|---|---|
| Size | 45.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b7fcef29f8371646a02189e6e240778c0dca522520fd5d6c5959f193b3706f9c
|
|
BLAKE2b-256 checksum How to use checksums |
3614c020929afbfd00e151740e5a4804881776794ac9dafdee133066f493a1f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 31, 2026.
Transparency logSecurity for ansys-hps-data-transfer-client 0.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for ansys_hps_data_transfer_client-0.5.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 31, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
