Skip to content

Commit

Permalink
Add missing user manual updates. (#1901)
Browse files Browse the repository at this point in the history
  • Loading branch information
@aaronweeden
aaronweeden authored Aug 21, 2024
1 parent 297a65d commit cf9341d
Show file tree
Hide file tree
Showing 8 changed files with 85 additions and 98 deletions.
28 changes: 17 additions & 11 deletions user_manual_builder/About.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ My Profile, About, Roadmap, Contact and Help
===============================================

On the upper right side of the XDMoD page, there are a series of five
buttons that allow the user to set his profile, get more information
buttons that allow you to set your profile, get more information
about XDMoD, view the XDMoD Roadmap, contact the XDMoD developers and
seek help.

Expand All @@ -20,10 +20,6 @@ My profile allows you to view and update general settings pertaining to
your account. To access your profile, click on the **My Profile** button
located in the upper right section of the portal.

Your current role will be displayed in the title bar of the **My
Profile** window. In the figure above, for example, it shows the user is
a **Program Officer**.

The first section in the **My Profile** window contains **User
Information** such as: First Name, Last Name, and Email Address. All of
the aforementioned fields must be specified in order to update your
Expand Down Expand Up @@ -51,6 +47,16 @@ follow.

Role Delegation Menu

Also in the **My Profile** window is a tab that allows you to create an
**API Token** to use with the
`Data Analytics Framework <https://pypi.org/project/xdmod-data>`_
(:numref:`api_token_menu`).

.. figure:: media/image137.png
:name: api_token_menu

API Token Menu

About Button
-----------------

Expand All @@ -72,9 +78,9 @@ Contact Button

Contact Us Button

Selecting the contact button will bring up a window that allows the user
to send a message to the XDMoD team. The user must fill in his name,
email address and his message.
Selecting the contact button will bring up a window that allows you
to send a message to the XDMoD team. You must fill in your name,
email address, and message.

.. figure:: media/image79.png
:name: my_profile_contact_window
Expand Down Expand Up @@ -114,7 +120,7 @@ simply want to view the Roadmap you can select the various Trello cards
shown in :numref:`about_trello_roadmap` for further details about each roadmap task.
You can also “vote” for a feature in the roadmap that you would
particularly like to use. To do this Sign Up or Log In to Trello (upper
right corner Figure 15-6). Then clicking on any roadmap feature such as
right corner :numref:`about_trello_roadmap`). Then clicking on any roadmap feature such as
X-Y plot capacity, will give you access to the Vote box, as shown in
:numref:`about_roadmap_voting`.

Expand All @@ -126,9 +132,9 @@ X-Y plot capacity, will give you access to the Vote box, as shown in
.. figure:: media/image119.png
:name: about_trello_roadmap

XDMD Roadmap on Trello.com
XDMoD Roadmap on Trello.com

.. figure:: media/image54.png
:name: about_roadmap_voting

Voting for a feature in the XDMD Roadmap on Trello.com
Voting for a feature in the XDMoD Roadmap on Trello.com
21 changes: 11 additions & 10 deletions user_manual_builder/Dashboard_Tab.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,10 @@ component.
The layout of the half-width dashboard components can be customized by
dragging the title bar of a component (:numref:`dashboard_rearrange_layout`). The layout
settings are saved automatically and persist between logins. The layout
can be reset to default using the “Reset to default” button in the
Settings tab of the “My Profile” dialog (:numref:`dashboard_reset_default`). The My Profile
dialog is accessed via the “My Profile” button on the top left of the
XDMoD portal. Full-width dashboard components cannot be moved.
can be reset to default using the **Reset to default** button in the
**Settings** tab of the **My Profile** dialog (:numref:`dashboard_reset_default`).
The **My Profile** dialog is accessed via the **My Profile** button on the top
right of the XDMoD portal. Full-width dashboard components cannot be moved.

.. figure:: media/image80.png
:name: dashboard_rearrange_layout
Expand All @@ -132,7 +132,8 @@ XDMoD portal. Full-width dashboard components cannot be moved.
:width: 66%

The dashboard layout can be reset to the default value
using the button available in the Settings tab of the Profile dialog.
using the button available in the **Settings** tab of the **My Profile**
dialog.

Chart Component
-------------------
Expand All @@ -151,15 +152,15 @@ component will open the chart in the Metric Explorer.

The default chart configuration settings are controlled by the
:only:`<Open>Open` XDMoD system administrator. Extra charts can be added
to the dashboard via the Metric Explorer. Charts are added via the “Show
in Summary tab” checkbox in the Metric Explorer basic chart options (see
to the dashboard via the Metric Explorer. Charts are added via the **Show
in Summary tab** checkbox in the Metric Explorer basic chart options (see
:numref:`Section %s<basic_chart_options>` for more information).

It is also possible to edit the default charts via the Metric Explorer.
Click the wheel icon on the top right of the chart component to open the
chart in the Metric Explorer. You can then edit the chart in the Metric
Explorer and save the chart *without* changing the chart name field or
deselecting the “Show in Summary tab” checkbox. To reset a system chart
deselecting the **Show in Summary tab** checkbox. To reset a system chart
to the default just delete it from the list of save charts in the Metric
Explorer.

Expand Down Expand Up @@ -229,15 +230,15 @@ the data are obtained from the Jobs realm and the component will display
The information displayed in the Jobs component is restricted by XDMoD’s
role based access controls. A summary of the data available is shown in
:only:`<Open>{open_account_restrictions}`:only:`<XSEDE>{xsede_account_restrictions}`
below. The “Filter by Person” widget is not displayed for
below. The **Filter by Person** widget is not displayed for
the user role since it is superfluous.

.. figure:: media/image64.png
:name: jobs_component

Annotated example of the Jobs component. The User role
does not have permission to list other users jobs and does not have the
“\ *Filter by Person”* widget. The Job overall CPU usage information is
**Filter by Person** widget. The Job overall CPU usage information is
only available if the optional Job Performance (SUPReMM) XDMoD module is
installed.

Expand Down
50 changes: 24 additions & 26 deletions user_manual_builder/Efficiency.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,36 +33,34 @@ usage and analytics associated with design. Usage analytics compare
resources allocated for a job to measured usage for the job. Design
analytics determine if jobs are using resources in an efficient manner
consistent with their design. :numref:`efficiency_analytics_table` below lists the available
analytics for the XDMoD 10.0 release and the associated description for
that analytic.
analytics and the associated description for each analytic.


.. _efficiency_analytics_table:

.. table:: Analytics available for display in the Efficiency Tab for XDMoD 10.0 Release.

+------------+-------------------------------------------+------------+
| ** | **Description** | ** |
| Analytic** | | Category** |
+============+===========================================+============+
| CPU Usage | Measures the percentage of time that the | Usage |
| | CPU cores were idle. | |
+------------+-------------------------------------------+------------+
| GPU Usage | Measures the percentage of time that the | Usage |
| | GPUs were busy. | |
+------------+-------------------------------------------+------------+
| Memory | Measures the overall highest memory usage | Usage |
| Usage | for jobs. | |
+------------+-------------------------------------------+------------+
| H | Measures how uniform the work rate of the | Usage |
| omogeneity | job is. | |
+------------+-------------------------------------------+------------+
| Wall Time | Measures how well used wall time matches | Design |
| Accuracy | requested wall time. | |
+------------+-------------------------------------------+------------+
| Short Jobs | Measures the number of jobs that ran for | Design |
| | 30 seconds or less. | |
+------------+-------------------------------------------+------------+
.. table:: Analytics available for display in the Efficiency Tab.

+--------------+-------------------------------------------+--------------+
| **Analytic** | **Description** | **Category** |
+==============+===========================================+==============+
| CPU Usage | Measures the percentage of time that the | Usage |
| | CPU cores were idle. | |
+--------------+-------------------------------------------+--------------+
| GPU Usage | Measures the percentage of time that the | Usage |
| | GPUs were busy. | |
+--------------+-------------------------------------------+--------------+
| Memory | Measures the overall highest memory usage | Usage |
| Usage | for jobs. | |
+--------------+-------------------------------------------+--------------+
| Homogeneity | Measures how uniform the work rate of the | Usage |
| | job is. | |
+--------------+-------------------------------------------+--------------+
| Wall Time | Measures how well used wall time matches | Design |
| Accuracy | requested wall time. | |
+--------------+-------------------------------------------+--------------+
| Short Jobs | Measures the number of jobs that ran for | Design |
| | 30 seconds or less. | |
+--------------+-------------------------------------------+--------------+

.. _scatter_plot_view:

Expand Down
5 changes: 3 additions & 2 deletions user_manual_builder/Job_Viewer.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,9 @@ here are normalized with values near 1 (displayed in green) indicating a
good value and values near 0 (displayed in red) indicating a poor value
for the metric. We note that not all jobs should be expected to have
good values for all metrics. The default metrics that are displayed are
CPU User Balance, Homogeneity, Memory Headroom and CPU User (see Figure
10-5). CPU User Balance indicates how well balanced the usage is between
CPU User Balance, Homogeneity, Memory Headroom and CPU User (see
:numref:`job_viewer_information`).
CPU User Balance indicates how well balanced the usage is between
the various cores in the job based on the fraction of time each core
spends in CPU user mode. CPU User Balance is defined as

Expand Down
79 changes: 30 additions & 49 deletions user_manual_builder/Metric_Explorer.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -288,55 +288,36 @@ Managing Filters
.. table::
:widths: 75 25

+----------------------------------------------+-----------------------+
| .. figure:: media/image38.png | As mentioned in the |
| :name: metric_explorer_filters | previous section, |
| | filters allow you to |
| Filters section of Metric Explorer | focus on a subset of |
| | the data. To apply |
| | filters to your data, |
| | you can either |
| | consult the *Local |
| | Filters* section of |
| | the *Data Series |
| | Definition* dialog |
| | (see **Figure |
| | 8-10**), or make use |
| | of *Global Filters* |
| | (see **Figure |
| | 8-11**). |
| | |
| | *Local* Filters are |
| | solely tailored to a |
| | single data series, |
| | whereas *Global* |
| | Filters are applied |
| | to all the data |
| | series you have |
| | introduced into the |
| | **Data** section of |
| | the Metric Explorer. |
| | |
| | To create a filter, |
| | click on the *Add |
| | Filter* button (as |
| | highlighted in |
| | **Figure 8-11**). |
| | Doing so will provide |
| | you with a list of |
| | dimensions (or |
| | parameters) you can |
| | filter with. Once you |
| | have selected a |
| | dimension, you will |
| | be presented with a |
| | dialog allowing you |
| | to navigate, search, |
| | and select parameter |
| | values. Click on OK |
| | to apply any selected |
| | filters. |
+----------------------------------------------+-----------------------+
+----------------------------------------------+---------------------------------------+
| .. figure:: media/image38.png | As mentioned in the previous section, |
| :name: metric_explorer_filters | filters allow you to focus on a |
| | subset of the data. To apply filters |
| Filters section of Metric Explorer | to your data, you can either consult |
| | the *Local Filters* section of the |
| | *Data Series Definition* dialog (see |
| | :numref:`metric_explorer_filters`), |
| | or make use of *Global Filters* (see |
| | :numref:`metric_filter_logic`). |
| | |
| | *Local* Filters are solely tailored |
| | to a single data series, whereas |
| | *Global* Filters are applied to all |
| | the data series you have introduced |
| | into the **Data** section of the |
| | Metric Explorer. |
| | |
| | To create a filter, click on the *Add |
| | Filter* button (as highlighted in |
| | :numref:`metric_filter_logic`). Doing |
| | so will provide you with a list of |
| | dimensions (or parameters) you can |
| | filter with. Once you have selected a |
| | dimension, you will be presented with |
| | a dialog allowing you to navigate, |
| | search, and select parameter values. |
| | Click on OK to apply any selected |
| | filters. |
+----------------------------------------------+---------------------------------------+

.. table::
:widths: 75 25
Expand Down
Binary file modified user_manual_builder/media/image112.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified user_manual_builder/media/image132.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added user_manual_builder/media/image137.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cf9341d

Please sign in to comment.