diff --git a/doc/changelog.d/219.documentation.md b/doc/changelog.d/219.documentation.md new file mode 100644 index 00000000..0ca0bd89 --- /dev/null +++ b/doc/changelog.d/219.documentation.md @@ -0,0 +1 @@ +docs: improve install instructions by adding pypi install \ No newline at end of file diff --git a/doc/source/getting-started/installing/linux.rst b/doc/source/getting-started/installing/linux.rst index d0511c8c..05dc0803 100644 --- a/doc/source/getting-started/installing/linux.rst +++ b/doc/source/getting-started/installing/linux.rst @@ -5,8 +5,33 @@ This page explains how to install PyWorkbench locally on a Linux platform. .. note:: - The following instructions assume that you have a local installation of Workbench and a valid - license in your machine. + The following instructions assume that you have a local installation of Workbench with a + valid license. + +There are two ways to install PyWorkbench on Linux: + +* `Install from PyPI `_ +* `Download artifacts `_ + + +Install from PyPI +================== + +PyWorkbench is available on the `Python Package Index (PyPI) `_. +You can install PyWorkbench using this `pip `_ command: + +.. code-block:: shell + + python -m pip install ansys-workbench-core + +Verify the installation by running this code: + +.. code-block:: python + + from ansys.workbench.core import launch_workbench + + launch_workbench() + Download artifacts ================== diff --git a/doc/source/getting-started/installing/windows.rst b/doc/source/getting-started/installing/windows.rst index ef5f382e..5a8c0f5f 100644 --- a/doc/source/getting-started/installing/windows.rst +++ b/doc/source/getting-started/installing/windows.rst @@ -8,6 +8,29 @@ This page explains how to install PyWorkbench locally on a Windows platform. The following instructions assume that you have a local installation of Workbench and a valid license in your machine. +There are two ways to install PyWorkbench on Windows: + +* `Install from PyPI `_ +* `Download artifacts `_ + +Install from PyPI +================== + +PyWorkbench is available on the `Python Package Index (PyPI) `_. +You can install PyWorkbench using this `pip `_ command: + +.. code-block:: shell + + python -m pip install ansys-workbench-core + +Verify the installation by running this code: + +.. code-block:: python + + from ansys.workbench.core import launch_workbench + + launch_workbench() + Download artifacts ==================