README.rst

PyHPS Data Transfer

Overview

Python client library for HPS Data Transfer Service

Installation

You can use pip to install PyHPS Data Transfer. Note: This will be available only after released. For now, please install from git

pip install ansys-hps-data-transfer-client

To install the latest development version, 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

This code shows how to import PyHPS Data Transfer and use some basic capabilities:

from ansys.hps.data_transfer.client import Client    # Import the Client class
client = Client()   # Create a client object

For comprehensive usage information, see Examples in the PyHPS Data Transfer documentation.

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].