Skip to content

docs: improve install instructions by adding pypi install #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
1 change: 1 addition & 0 deletions doc/changelog.d/219.documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs: improve install instructions by adding pypi install
29 changes: 27 additions & 2 deletions doc/source/getting-started/installing/linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Install from PyPI_>`_
* `Download artifacts <Download artifacts_>`_


Install from PyPI
==================

PyWorkbench is available on the `Python Package Index (PyPI) <https://pypi.org/project/ansys-workbench/>`_.
You can install PyWorkbench using this `pip <https://pypi.org/project/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
==================
Expand Down
23 changes: 23 additions & 0 deletions doc/source/getting-started/installing/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <Install from PyPI_>`_
* `Download artifacts <Download artifacts_>`_

Install from PyPI
==================

PyWorkbench is available on the `Python Package Index (PyPI) <https://pypi.org/project/ansys-workbench/>`_.
You can install PyWorkbench using this `pip <https://pypi.org/project/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
==================

Expand Down
Loading