.. _examples:

.. note::
    Go to the `bottom of this page`_ to download the ZIP file containing the resources required 
    to follow all examples. A link to download the required resources for each example
    is also available on each example page.

Examples
========

The examples in this section show how to interact with an HPS server in Python using
PyHPS. Each example consists of a Python script plus a data file, such as a solver input file. 
You can execute many Python scripts with these command-line arguments:

* ``-n``, ``--name``: Name of the HPS project
* ``-U``, ``--url``: URL or the HPS server (default: https://localhost:8443/hps)
* ``-u``, ``--username``: HPS username (default: repuser)
* ``-p``, ``--password``: HPS password (default: repuser)
* ``-v``, ``--ansys-version``: Ansys version

A link to download the required resources is available on each example page. If
desired, you can download the required resources for all examples by downloading
one :download:`ZIP file <../../../build/pyhps_examples.zip>`.

.. toctree::
  :hidden:
  :maxdepth: 3

  ex_motorbike_frame
  ex_motorbike_frame_query
  ex_mapdl_tire_performance
  ex_mapdl_linked_analyses
  ex_lsdyna_job
  ex_fluent_2d_heat_exchanger
  ex_fluent_nozzle
  ex_cfx_static_mixer
  ex_python_two_bar
  ex_python_uv
  ex_python_pyansys_cantilever

.. list-table::
   :header-rows: 1

   * - Name
     - Description
   * - :ref:`example_mapdl_motorbike_frame`
     - Create from scratch an HPS project consisting of an Ansys APDL beam model of a tubular steel trellis motorbike frame. This example shows how to create a parameter study and submit design points.
   * - :ref:`example_mapdl_motorbike_frame_query`
     - Query an existing project and download output files.
   * - :ref:`example_mapdl_tire_performance`
     - Submit an MAPDL analysis as a single job. Solution convergence and contact tracking files are periodically collected. 
   * - :ref:`example_mapdl_linked_analyses`
     - Submit an MAPDL linked analysis workflow as a multi-task job to the HPS server.
   * - :ref:`example_lsdyna_job`
     - Submit, monitor, and download results of an LS-DYNA job. 
   * - :ref:`example_fluent_2d_heat_exchanger`
     - Submit a Fluent solve job to the HPS server.
   * - :ref:`example_fluent_nozzle`
     - Submit a Fluent solve job to the HPS server using an execution script.
   * - :ref:`example_cfx_static_mixer`
     - Submit a CFX solve job to the HPS server using an execution script.
   * - :ref:`example_python_two_bar`
     - Create an HPS project that solves a two-bar truss problem with Python.
   * - :ref:`example_python_uv`
     - Run arbitrary Python scripts on HPS using uv.
   * - :ref:`example_python_pyansys_cantilever`
     - Run PyAnsys scripts on HPS. This example parametrizes a cantilever and submits a number of design points.

A link to download the required resources is available on each example page. If desired, 
you can download the required resources for all examples using the following link.

.. _bottom of this page:

.. button-link:: ../_downloads/pyhps_examples.zip
    :color: black
    :expand:

    Download ZIP file for all examples