Skip to content

Commit

Permalink
STY: Minor edits to tutorial docs and server
Browse files Browse the repository at this point in the history
  • Loading branch information
nstelter-slac committed Oct 8, 2023
1 parent 580b1d9 commit 9bb4882
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 6 deletions.
2 changes: 2 additions & 0 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Install:

=========================
Installation
=========================
Expand Down
6 changes: 3 additions & 3 deletions docs/source/tutorials/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ The server mimics some PVs of a motor and camera, and is located as follows:
examples/testing_ioc/pydm-tutorial-ioc
Running 'pip install -r requirements.txt' provides all needed prerequisites.
Installing PCASpy from the documentation above and following the :ref:`pydm installation instructions<Install>` provides all needed prerequisites for this tutorial.

Using the PCASpy Server
^^^^^^^^^^^^^^^^^^^^^^^^^

.. note::
You will need to export the following variable in each terminal that will run either the PCASpy server or pydm:
.. code-block:: bash
.. code-block:: bash
export EPICS_CA_MAX_ARRAY_BYTES=300000
Expand All @@ -32,7 +32,7 @@ Run the server as follows:
In another terminal window, enable the sever's running state:
.. code-block:: bash
caput MTEST:Run 1
caput IOC:Run 1
The server will now be running and the tutorial files can access the necessary PV's.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/widgets/PyDMWidget.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ API Documentation
:show-inheritance:

PyDMToolTip Instructions
=================Z
=================
The PyDMToolTip property field takes a string. In the PyDMToolTip property field, the user can include the tag $(pv_value) to get the value of the
channel displayed on the tool tip.

Expand Down
4 changes: 2 additions & 2 deletions examples/testing_ioc/pydm-tutorial-ioc
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ import time
from pcaspy import Driver, SimpleServer

""" This file provides the server needed for for providing PVs to run the tutorial.
You can follow along the tutorial here: hhttps://slaclab.github.io/pydm/tutorials/index.html
You can follow along the tutorial here: https://slaclab.github.io/pydm/tutorials/index.html
The server mimics variables used by the tutorial, which mimic a simulated camera and motor.
Mimicking this behavior is done (over running simulator programs) in order to minimize the overhead
to get the tutorial up-and-running, and since the simulated data is not necessarily needed to learn
how to make PyDM user-interface.
how to make a PyDM user-interface.
"""

MAX_POINTS = 1000
Expand Down

0 comments on commit 9bb4882

Please sign in to comment.