.. _getting_started:

Getting started
===============

This section describes how to install PyHPS Data Transfer in user mode. If you are interested in contributing
to PyHPS Data Transfer, see :ref:`contribute` for information on installing in developer mode.

Prerequisites
-------------

You must have pip_ and Python 3.9, 3.10, 3.11, or 3.12 installed.

#. To see if a Python 3.x version is installed and available from your command line,
   run this command:

   .. code::

       python --version

#. If a Python 3.x version is not available, install the latest 3.x version from the
   Python organization's `Downloads <https://www.python.org/downloads/>`_ page.

#. To see if you have ``pip`` installed, run this command:

   .. code::

       pip --version

#. If ``pip`` is not installed, see `Installing Packages <https://packaging.python.org/tutorials/installing-packages/>`_
   in the *Python Packaging User Guide*.

#. To ensure that you have the latest version of ``pip``, run this command:

   .. code::

       python -m pip install -U pip


Installation
------------

To install PyHPS Data Transfer in user mode, run this command:

.. code:: bash

    python -m pip install ansys-hps-data-transfer-client

.. LINKS AND REFERENCES
.. _pip: https://pypi.org/project/pip/