Skip to content

Commit 7d85438

Browse files
authored
doc: technical review (#81)
2 parents b25c8b6 + 6e2618e commit 7d85438

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
doc: technical review

doc/source/user-guide.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,11 @@ key concepts and approaches when working with the Workbench gRPC service.
77
Start Workbench client and connect to a running Workbench server
88
================================================================
99

10-
A typical user of the Workbench gRPC service starts a Workbench client that connects to
11-
a running Workbench server on the cloud, given the server's name/IP and port.
10+
To start a Workbench client that connects to a running Workbench server on cloud, provide the following details:
11+
12+
- Server name/IP
13+
- Port number
14+
- Client-side working directory. This directory is the default location for client-side files
1215

1316
.. code-block:: python
1417
@@ -23,11 +26,12 @@ Other options to the ``connect_workbench`` API include specifying a working dire
2326
Launch Workbench server and start a client
2427
==========================================
2528

26-
During the development phase or for debugging purposes, it is useful to start the Workbench server on the developer's desktop or some computer within the company network.
29+
During development phase or for debugging purpose, it is useful to start
30+
Workbench server on your desktop or some computer within the company network.
2731

28-
One can always start a Workbench server by executing the command `StartServer()` in any running Workbench session and use the returned server port to start a client, like in the example above.
32+
You can always start a Workbench server by executing the command `StartServer()` in any running Workbench session and use the returned server port to start a client, like in the example above.
2933

30-
Alternatively, one can launch a Workbench server and start a client programmatically in a client-side Python script. To launch a server on the local computer:
34+
Alternatively, you can launch a Workbench server and start a client programmatically in a client-side Python script. To launch a server on a remote Windows machine with valid user credentials:
3135

3236
.. code-block:: python
3337
@@ -61,10 +65,10 @@ Other options to the ``launch_workbench`` API include specifying a particular Wo
6165
Run script/commands/queries on Workbench server
6266
===============================================
6367

64-
IronPython based Workbench scripts containing commands/queries can be executed on the server via:
68+
IronPython based Workbench scripts containing commands/queries can be executed on the server via
6569

66-
* `run_script_file`, which executes a script file in the client working directory; or
67-
* `run_script_string`, which executes a script contained in the given string.
70+
- ``run_script_file``, which executes a script file in the client working directory; or
71+
- ``run_script_string``, which executes a script contained in the given string
6872

6973
Any output that needs to be returned from these APIs can be assigned to the global variable `wb_script_result` in the script as a JSON string. For example, the following Workbench script returns all message summaries from the Workbench session:
7074

@@ -84,9 +88,9 @@ These run_script APIs can also be called with different logging levels. The defa
8488
File handling
8589
=============
8690

87-
Data files can be uploaded to the server or downloaded from the server, using `upload_file` or `download_file` API. The client-side working directory is used to hold these files unless absolute paths or target directories are specified. There is also a working directory on the server for the same purpose. The server's working directory can be obtained via the Workbench query `GetServerWorkingDirectory()` that runs on the server.
91+
Data files can be uploaded to the server or downloaded from the server, using `upload_file` or `download_file` API. The client-side working directory is used to hold these files unless absolute paths or target directories are specified. There is also a working directory on the server for the same purpose. The servers working directory can be obtained via the Workbench query GetServerWorkingDirectory() that runs on the server.
8892

89-
For example, this uploads all part files with a given prefix and all agdb files in the working directory, plus another file outside of the working directory, from client to server:
93+
The following script uploads all part files with a given prefix and all AGDB files in the working directory, plus another file outside of the working directory, from client to server:
9094

9195
.. code-block:: python
9296
@@ -133,7 +137,7 @@ There is a special client API to upload a data file from `the ANSYS example data
133137
134138
client.upload_file_from_example_repo("pymechanical-integration/agdb/two_pipes.agdb")
135139
136-
All the file handling APIs come with a progress bar that is shown by default. One can turn off the progress bar with an optional argument:
140+
All the file handling APIs come with progress bar that is shown by default. You can turn off the progress bar with an optional argument:
137141

138142
.. code-block:: python
139143
@@ -145,7 +149,7 @@ Start other PyANSYS services from systems in a PyWorkbench project
145149
PyMechanical
146150
------------
147151

148-
For any mechanical system in the Workbench project, the PyMechanical service can be started and connected to from the same client machine.
152+
For any Mechanical system in the Workbench project, the PyMechanical service can be started and connected to from the same client machine.
149153
The following runs a server-side script to create a mechanical system, then starts the PyMechanical service for the system and establishes a PyMechanical client.
150154

151155
.. code-block:: python

0 commit comments

Comments
 (0)