diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index ce4408c69..ae405f788 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -77,9 +77,9 @@ jobs: issue-number: ${{ github.event.pull_request.number }} body: | Please add one of the following labels to add this contribution to the Release Notes :point_down: - - [bug]([https://github.com/pyansys/pyrep/pulls?q=label%3Abug+) - - [documentation]([https://github.com/pyansys/pyrep/pulls?q=label%3Adocumentation+) - - [enhancement]([https://github.com/pyansys/pyrep/pulls?q=label%3Aenhancement+) - - [good first issue]([https://github.com/pyansys/pyrep/pulls?q=label%3Agood+first+issue) - - [maintenance]([https://github.com/pyansys/pyrep/pulls?q=label%3Amaintenance+) - - [release]([https://github.com/pyansys/pyrep/pulls?q=label%3Arelease+) + - [bug]([https://github.com/pyansys/pyhps/pulls?q=label%3Abug+) + - [documentation]([https://github.com/pyansys/pyhps/pulls?q=label%3Adocumentation+) + - [enhancement]([https://github.com/pyansys/pyhps/pulls?q=label%3Aenhancement+) + - [good first issue]([https://github.com/pyansys/pyhps/pulls?q=label%3Agood+first+issue) + - [maintenance]([https://github.com/pyansys/pyhps/pulls?q=label%3Amaintenance+) + - [release]([https://github.com/pyansys/pyhps/pulls?q=label%3Arelease+) diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 6825370da..512059d52 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -125,7 +125,7 @@ jobs: - name: Upload artifact uses: actions/upload-artifact@v3 with: - name: pyrep-package + name: pyhps-package path: | dist/*.whl retention-days: 5 diff --git a/README.rst b/README.rst index 1e06b4d99..43c57b423 100644 --- a/README.rst +++ b/README.rst @@ -14,12 +14,12 @@ PyHPS :target: https://pypi.org/project/ansys-rep :alt: PyPI -.. |codecov| image:: https://codecov.io/gh/pyansys/pyrep/branch/main/graph/badge.svg - :target: https://codecov.io/gh/pyansys/pyrep +.. |codecov| image:: https://codecov.io/gh/pyansys/pyhps/branch/main/graph/badge.svg + :target: https://codecov.io/gh/pyansys/pyhps :alt: Codecov -.. |GH-CI| image:: https://github.com/pyansys/pyrep/actions/workflows/ci_cd.yml/badge.svg - :target: https://github.com/pyansys/pyrep/actions/workflows/ci_cd.yml +.. |GH-CI| image:: https://github.com/pyansys/pyhps/actions/workflows/ci_cd.yml/badge.svg + :target: https://github.com/pyansys/pyhps/actions/workflows/ci_cd.yml :alt: GH-CI .. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg @@ -47,9 +47,9 @@ Then, as long as PyHPS is a private pyAnsys module not published to pypi yet, yo .. code:: bash - python -m pip install git+https://github.com/pyansys/pyrep + python -m pip install git+https://github.com/pyansys/pyhps -.. TODO: Enable this once pyrep is published: python -m pip install ansys-rep +.. TODO: Enable this once pyhps is published: python -m pip install ansys-pyhps Contribute ---------- @@ -62,8 +62,8 @@ need to follow these steps: .. code:: bash - git clone https://github.com/pyansys/pyrep - cd pyrep + git clone https://github.com/pyansys/pyhps + cd pyhps #. Create a new Python environment and activate it: diff --git a/ansys/hps/client/__version__.py b/ansys/hps/client/__version__.py index 337892ac5..bf0ddf201 100644 --- a/ansys/hps/client/__version__.py +++ b/ansys/hps/client/__version__.py @@ -2,8 +2,8 @@ __version_no_dots__ = __version__.replace(".", "") __company__ = "ANSYS, Inc." __company_short__ = "Ansys" -__url__ = "https://github.com/ansys-internal/pyrep" +__url__ = "https://github.com/ansys-internal/pyhps" # this is only a convenience to default the version -# of Ansys simulation applications in pyrep examples +# of Ansys simulation applications in pyhps examples __ansys_apps_version__ = "2024 R1" diff --git a/doc/source/conf.py b/doc/source/conf.py index 17d11f71d..4f273fd4f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -13,7 +13,7 @@ # -- Project information ----------------------------------------------------- # General information about the project. -project = "Ansys pyrep" +project = "Ansys pyhps" copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved" author = __company__ @@ -120,7 +120,7 @@ # only for sphinx_rtd_theme html_theme_options = { - "github_url": "https://github.com/pyansys/pyrep", + "github_url": "https://github.com/pyansys/pyhps", "show_prev_next": False, "show_breadcrumbs": True, "additional_breadcrumbs": [ @@ -160,7 +160,7 @@ # html_use_opensearch = '' # Output file base name for HTML help builder. -htmlhelp_basename = "pyrepdoc" +htmlhelp_basename = "pyhpsdoc" # -- Options for LaTeX output --------------------------------------------- diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst index c0dc3c55e..5bda0982e 100644 --- a/doc/source/examples/index.rst +++ b/doc/source/examples/index.rst @@ -15,7 +15,7 @@ Many of the Python scripts can be executed with the following command line argum A link to download all the required resources is available at each example page. -You can also download the entire set of examples :download:`Download All Examples <../../../build/pyrep_examples.zip>`. +You can also download the entire set of examples :download:`Download All Examples <../../../build/pyhps_examples.zip>`. .. toctree:: :hidden: diff --git a/doc/source/index.rst b/doc/source/index.rst index 083d504b5..bd85c4149 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,11 +13,10 @@ PyHPS Documentation |version| Introduction ------------ -Ansys Remote Execution Platform (REP) is a family of applications that enables you to distribute, -manage and solve simulations on a variety of compute resources. +Ansys HPC Platform Services (HPS) is a set of technology components designed to help you manage the execution of simulations while making use of your full range of computing assets. -``ansys-pyhps`` brings Ansys REP to your Python application. -Wrapping around the REP REST APIs, it allows you to: +``ansys-pyhps`` brings Ansys HPS to your Python application. +Wrapping around the HPS REST APIs, it allows you to: * create new projects and modify existing ones * monitor and manage jobs diff --git a/doc/source/install.rst b/doc/source/install.rst index a1a636b1f..475c184bc 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -24,7 +24,7 @@ As long as PyHPS is a private PyAnsys package not published to PyPI yet, you can .. code:: - python -m pip install git+https://github.com/pyansys/pyrep + python -m pip install git+https://github.com/pyansys/pyhps The following dependencies are automatically installed through ``pip`` (if not already available): diff --git a/examples/cfx_static_mixer/project_setup.py b/examples/cfx_static_mixer/project_setup.py index 15eb08ee2..06254119e 100644 --- a/examples/cfx_static_mixer/project_setup.py +++ b/examples/cfx_static_mixer/project_setup.py @@ -1,5 +1,5 @@ """ -Example script to setup a simple CFX project in pyrep. +Example script to setup a simple CFX project in pyhps. """ import argparse import logging @@ -25,7 +25,7 @@ def create_project(client, name, num_jobs=20, version=__ansys_apps_version__): """ - Create a REP project consisting of an ANSYS CFX model. + Create an HPS project consisting of an ANSYS CFX model. """ jms_api = JmsApi(client) log.debug("=== Project") diff --git a/examples/fluent_2d_heat_exchanger/project_setup.py b/examples/fluent_2d_heat_exchanger/project_setup.py index 3d79f8fb8..eb1575818 100644 --- a/examples/fluent_2d_heat_exchanger/project_setup.py +++ b/examples/fluent_2d_heat_exchanger/project_setup.py @@ -1,5 +1,5 @@ """ -This example shows how to submit a simple Fluent 2D job to REP. +This example shows how to submit a simple Fluent 2D job to HPS. """ import argparse diff --git a/examples/fluent_nozzle/project_setup.py b/examples/fluent_nozzle/project_setup.py index 0c7f89945..00a29899c 100644 --- a/examples/fluent_nozzle/project_setup.py +++ b/examples/fluent_nozzle/project_setup.py @@ -1,5 +1,5 @@ """ -Example script to setup a simple Fluent project in pyrep. +Example script to setup a simple Fluent project in pyhps. """ import argparse import logging @@ -25,7 +25,7 @@ def create_project(client, name, num_jobs=20, version=__ansys_apps_version__): """ - Create a REP project consisting of an Ansys Fluent model. + Create an HPS project consisting of an Ansys Fluent model. """ jms_api = JmsApi(client) log.debug("=== Project") diff --git a/examples/lsdyna_cylinder_plate/lsdyna_job.py b/examples/lsdyna_cylinder_plate/lsdyna_job.py index 1390aa04d..671d642de 100644 --- a/examples/lsdyna_cylinder_plate/lsdyna_job.py +++ b/examples/lsdyna_cylinder_plate/lsdyna_job.py @@ -1,5 +1,5 @@ """ -Script showing how to submit an LS-DYNA job to REP. +Script showing how to submit an LS-DYNA job to Ansys HPC Platform Services. Once submitted, minimal job information are serialized to a JSON file rep_job.json. This mimics what an application would need to store in order to diff --git a/examples/mapdl_linked_analyses/project_setup.py b/examples/mapdl_linked_analyses/project_setup.py index 3ff838aa0..7c26dbb21 100644 --- a/examples/mapdl_linked_analyses/project_setup.py +++ b/examples/mapdl_linked_analyses/project_setup.py @@ -1,6 +1,6 @@ """ Script showing how to submit an MAPDL linked analysis workflow (prestress-modal-harmonic) -as a multi-task job to REP. +as a multi-task job to Ansys HPC Platform Services. The script shows two possible ways to submit the individual tasks: 1. All-at-one: all 3 tasks are defined and included in the diff --git a/examples/mapdl_motorbike_frame/project_setup.py b/examples/mapdl_motorbike_frame/project_setup.py index 9b0f61f2c..dfc398924 100644 --- a/examples/mapdl_motorbike_frame/project_setup.py +++ b/examples/mapdl_motorbike_frame/project_setup.py @@ -1,5 +1,5 @@ """ -Example script to setup a simple MAPDL project with parameters in pyrep. +Example script to setup a simple MAPDL project with parameters in pyhps. Author(s): O.Koenig """ @@ -35,7 +35,7 @@ def create_project( client, name, version=__ansys_apps_version__, num_jobs=20, use_exec_script=False, active=True ) -> Project: """ - Create a REP project consisting of an ANSYS APDL beam model of a motorbike-frame. + Create an HPS project consisting of an ANSYS APDL beam model of a motorbike-frame. After creating the project job_definition, 10 design points with randomly chosen parameter values are created and set to pending. diff --git a/examples/mapdl_tyre_performance/project_setup.py b/examples/mapdl_tyre_performance/project_setup.py index 860114bc1..466f1e765 100644 --- a/examples/mapdl_tyre_performance/project_setup.py +++ b/examples/mapdl_tyre_performance/project_setup.py @@ -1,5 +1,5 @@ """ -Example to submit a nonlinear tyre analysis job in REP. +Example to submit a nonlinear tyre analysis job to Ansys HPC Platform Services. ANSYS APDL Tire-Performance Simulation example as included in the technology demonstration guide (td-57). diff --git a/prepare_documentation.py b/prepare_documentation.py index b2d709bc7..b452f15e2 100644 --- a/prepare_documentation.py +++ b/prepare_documentation.py @@ -182,7 +182,7 @@ def archive_examples(): for file in files: zip_archive.write(os.path.join("examples", name, file), file) - with ZipFile(os.path.join("build", f"pyrep_examples.zip"), "w") as zip_archive: + with ZipFile(os.path.join("build", f"pyhps_examples.zip"), "w") as zip_archive: for name, files in examples.items(): for file in files: zip_archive.write(os.path.join("examples", name, file), os.path.join(name, file))