From 3cdeb5fb0ec6f10df77f10d0610831d0821a3b1b Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Wed, 21 Feb 2024 08:49:53 +0100 Subject: [PATCH 1/2] docs: installation steps --- doc/source/contribute.rst | 3 ++- doc/source/getting_started/index.rst | 9 ++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/contribute.rst b/doc/source/contribute.rst index e174a97d5..a9cbcf4b5 100644 --- a/doc/source/contribute.rst +++ b/doc/source/contribute.rst @@ -21,7 +21,7 @@ Installing PyHPS in developer mode allows you to modify and enhance the source: .. code:: bash - git clone https://github.com/pyansys/pyhps + git clone https://github.com/ansys-internal/pyhps #. Access the directory where you have cloned the repository: @@ -111,6 +111,7 @@ This way, it's not possible for you to push code that fails the style checks:: isort....................................................................Passed flake8...................................................................Passed codespell................................................................Passed + Add License Headers......................................................Passed Documentation ------------- diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index 2024422a1..b89497e71 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -40,14 +40,13 @@ You must have pip_ and Python 3.9, 3.10, 3.11, or 3.12 installed. Installation ------------ -Because PyHPS is a private PyAnsys package not yet published to PyPI, install it by -running this command: +To install PyHPS in user mode, run this command: -.. code:: +.. code:: bash - python -m pip install git+https://github.com/ansys-internal/pyhps + python -m pip install ansys-hps-client -``pip`` automatically installs any of these package dependencies that are not already installed: +``pip`` automatically installs these package dependencies in case they are not already installed: - requests_ - marshmallow_ From 47a0a326df07851fea0f8e4997a8cf678c736b65 Mon Sep 17 00:00:00 2001 From: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Date: Wed, 21 Feb 2024 08:51:39 +0100 Subject: [PATCH 2/2] Update doc/source/getting_started/index.rst --- doc/source/getting_started/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index b89497e71..4c395abbb 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -44,7 +44,7 @@ To install PyHPS in user mode, run this command: .. code:: bash - python -m pip install ansys-hps-client + python -m pip install ansys-hps-client ``pip`` automatically installs these package dependencies in case they are not already installed: