Pre-release

This release is a pre-release and may not be stable for production use.

PyAnsys Python PyPI GH-CI Codecov MIT Ruff

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 pyansys.core@ansys.com.

Project links

Data verified by PyPI on Aug 6, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Stable release available (0.5.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ansys from gravatar.com ansys

Credits

Author/Maintainer: ANSYS, Inc.

GitHub Statistics

Data verified by PyPI on Aug 6, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License

Requires

Python <4.0, >=3.10

Provides Extra

build doc example tests

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansys_hps_data_transfer_client-0.6.dev0.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ansys_hps_data_transfer_client-0.6.dev0-py3-none-any.whl (45.4 kB view details)

Uploaded Python 3

File details

Details for the file ansys_hps_data_transfer_client-0.6.dev0.tar.gz.

File metadata

File hashes

Hashes for ansys_hps_data_transfer_client-0.6.dev0.tar.gz
Algorithm Hash digest
SHA256 46a889c932900a2986e930b454d909179de59ef19225046afd3c85410e7e40a3
MD5 bcc665fe802f93693481c2f190910583
BLAKE2b-256 c352f06a4a485f7a71cadef74d2dc26a425a5ffa405a5a58048dcb1e7a1f8a85

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_hps_data_transfer_client-0.6.dev0.tar.gz:

Publisher: ci_cd.yml on ansys/pyhps-data-transfer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ansys_hps_data_transfer_client-0.6.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for ansys_hps_data_transfer_client-0.6.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 5127b5a9c6f2efa60c03c084bb127106200c001e41c0a1680047fae783faf203
MD5 c8f4de01c6616c5830f2c02b681a8fad
BLAKE2b-256 ec2a22107ffca5e6da4abb04aeac80e189068b87009ce80e8e1dc9d3f01390d3

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_hps_data_transfer_client-0.6.dev0-py3-none-any.whl:

Publisher: ci_cd.yml on ansys/pyhps-data-transfer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page