Skip to content

Commit

Permalink
removed Back to top button + better explanation of kafka
Browse files Browse the repository at this point in the history
  • Loading branch information
bruceravel committed Aug 28, 2024
1 parent a81d036 commit 481e0b1
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 33 deletions.
6 changes: 6 additions & 0 deletions docs/_static/demeter.css
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,9 @@ div.admonition-note {
/* code, pre { */
/* padding: 0; */
/* } */

/* The disappears the damn "Back to top" button from Pydata */
/* which is not otherwise configurable using html_theme_options */
button.rounded-pill {
display: none !important;
}
62 changes: 33 additions & 29 deletions docs/desktop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Phoebus (engineering screens)
If you first opened a new window or tab, you can safely close it.

There should be an icon for Phoebus on the icon bar at the bottom of
the screen. It looks like a red eyeball. Click on it.
the lower, left screen. It looks like a red eyeball. Click on it.

Once Phoebus is open, if the layout was not restored, click on the
"Window" menu, then on "Load Layout", then select "Two cameras".
Expand All @@ -63,7 +63,7 @@ cadashboard

Resize the height to just cover the three lines of the dashboard.
Move the terminal to the very top of the top screen. You can hide
the window decoration by using :key:`Windows`-\ :mark:`rightclick,.`
the window decoration by using :key:`Windows`-\ :mark:`leftclick,.`
to position the terminal window.


Expand All @@ -82,38 +82,26 @@ cadashboard
Data collection and visualization
---------------------------------

The easiest way to manage data collection and visualization is to have
a terminal window with 3 tabs. One tab is used for ``bsui``, the data
acquisition program. A second tab is for the Kafka consumer which
handles most data visualization chores. The third tab is just a
normal bash command line, which is always handy to have available.
Data collection and visualization are separate things and should be
managed separately.

Once you have a three-tab setup, go to the tab for ``bsui``. At the
On the main virtual desktop, open a terminal window for bsui. At the
command line type ``bsui``. ``bsui`` startup at BMM is rather
time-consuming, but after a couple minutes it is ready to go.


Now go to the tab for the Kafka consumer. At the command line, type
``run-consumer``. This will take a minute or so to start, eventually
saying ``Ready to receive documents...``. At this point, scans will
generate plots.
On the right-most virtual desktop, you will setup the Kafka file and
plot workers as explained in :numref:`the section on Kafka workers
(Section %s) <start_consumer>`.


.. subfigure:: AB
:layout-sm: AB
:subcaptions: above
:name: startup
:class-grid: outline

.. image:: _images/bsui_startup2.png

.. image:: _images/consumer_startup.png

(Right) The tail end of the ``bsui`` startup messages and the
command prompt in the ``bsui`` tab. (Left) The Kafka plotting
consumer in its tab awaiting commands from ``bsui``.

.. figure:: _images/bsui_startup2.png
:target: _images/bsui_startup2.png
:width: 80%
:align: center

The tail end of the ``bsui`` startup messages and the
command prompt.


All the rest
Expand All @@ -126,7 +114,23 @@ experiment:
%s) <cheatsheet>` and the XAS webcam.
+ Slack
+ A dolphin (file browser) window with a tab open to the current
experiment
Workspace folder

Note that there is a button on the icon bar at the bottom of the
screen for Hephaestus.

In the new data security regime, launching Athena as the beamline
account (``xf06bm``) is not very helpful given that it cannot access
the data.

If data are accessed by opening a terminal window and doing
``su - <username>`` followed by authentication with password and DUO,
first ``cd`` to the proposal directory, the start Athena with this
command:

.. code-block:: bash
dathena > /dev/null 2>&1 &
Note that there are buttons on the icon bar at the bottom of the
screen for Athena and Hephaestus.
That will open Athena and suppress the large stream of uniteresting
warning messages from the graphics tool kit.
8 changes: 4 additions & 4 deletions docs/kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,15 @@ queue-server and begin collecting data.


.. _fig-consumer:
.. figure:: _images/consumer.png
:target: _images/consumer.png
.. figure:: _images/consumer_startup.png
:target: _images/consumer_startup.png
:width: 70%
:align: center

A terminal window in which the Kafka consumer has just been started.
A terminal window in which the Kafka consumers have been started.

.. todo:: Update this figure

.. todo:: update the figure above


A few words about Kafka
Expand Down

0 comments on commit 481e0b1

Please sign in to comment.