From 541a41ecb5741f7b224327a546c503b9c7a0cd31 Mon Sep 17 00:00:00 2001 From: Bruce Ravel Date: Thu, 7 Sep 2023 10:35:39 -0400 Subject: [PATCH] some edits --- docs/automation.rst | 12 +++++++----- docs/profile.rst | 4 ++-- docs/xafs.rst | 8 +++++--- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/automation.rst b/docs/automation.rst index b1fb622..0e348cf 100644 --- a/docs/automation.rst +++ b/docs/automation.rst @@ -61,9 +61,9 @@ indicated measurements. In :numref:`Figure %s green background. All rows underneath the green line are used to describe individual measurements. -For an individual measurement, if a cell is left blank, the default -value will be used. If a cell is filled in, that value will be used -for that measurement. +For an individual measurement, if a white cell is left blank, the +default value from the corresponding green cell will be used. If a +white cell is filled in, that value will be used for that measurement. Experimenters ~~~~~~~~~~~~~ @@ -107,8 +107,10 @@ Selecting a spreadsheet All spreadsheets are imported using the :file:`xlsx()` command. The spreadsheets are self-identifying. Every spreadsheet has an identifying string spanning cells B1:C1. This is the cell with the -pink background. **Never** change the text in that cell or you run -the risk of your spreadsheet being interpreted incorrectly. +pink background. + +.. caution:: **Never** change the text in the pink cell or your + spreadsheet will likely be interpreted incorrectly. To convert a spreadsheet into a macro then run the macro, do the following: diff --git a/docs/profile.rst b/docs/profile.rst index 02e421b..952546b 100644 --- a/docs/profile.rst +++ b/docs/profile.rst @@ -153,7 +153,7 @@ Early in the loading of the profile, a function called ``BMM/functions.py`` and called near the top of ``BMM/user_ns/bmm.py``, which is the second file loaded by ``BMM/user_ns/__init__.py``. So, it is defined very early in the -process if loading the profile. +process of loading the profile. This is used to write a message to the screen explaining what chore is being done during start-up or what file is being loaded. As such it @@ -164,7 +164,7 @@ is very similar to the common python idiom of print(__file__) to identify the module or source code file being loaded. While -similar in concept, it is a bit more flexible. +similar in concept, it is a bit more suited to our purpose. .. _fig-bsui_startup: .. figure:: _images/bsui_startup.png diff --git a/docs/xafs.rst b/docs/xafs.rst index 183b4a4..3d992b6 100644 --- a/docs/xafs.rst +++ b/docs/xafs.rst @@ -744,6 +744,7 @@ BlueSky plan. +.. _xdiexample: XAFS data file @@ -982,14 +983,15 @@ Extract XRF spectra from fluorescence XAS BMM offers a handy tool for examining the XRF spectra of a fluorescence XAS scan on a point-by-point basis. Given the UID of a scan |nd| which can be found in :numref:`the dossier (Section %s) -` or in the text of the data file |nd|, you can plot the XRF -spectrum at a given point in the scan. +` or in :numref:`the header of the data file (Section %s) +` |nd| you can plot the XRF spectrum at a given point in +the scan. .. sourcecode:: python xrfat(uid, energy) -where ``uid`` is a string containing the scan UID and ``energy`` is +Here, ``uid`` is a string containing the scan UID and ``energy`` is one of the following: + an energy point in the scan range, the nearest energy point will be