Spelling

Author: Tom-Willemsen

doc/FAQ.rst

@@ -50,8 +50,8 @@ How do I view which new IBEX features have been requested or are being worked on
 
 There are internal lists showing priorities available covering the work which will feed into IBEX, please ask the experiment controls group or your group leader if you need to see these. These lists give you an idea of the long term work, and the priorities at that level.
 IBEX is released and deployed to each instrument at least once a year, with patches as required. To see what is being worked on for the next release, you will need to find the most recent PI project on https://github.com/orgs/ISISComputingGroup/projects, note that these are in the format PI_YYYY_MM, with the month being the one the PI starts in.
-The shortest time scale we consider is a sprint, and you can view this information on github at https://github.com/ISISComputingGroup/IBEX/projects/1.
-There is also a long list of issues on github that can be viewed at https://github.com/ISISComputingGroup/IBEX/issues. Please note, this is a rather long list and not very friendly to browse through unless you already know what you're looking for (e.g. a device name).
+The shortest time scale we consider is a sprint, and you can view this information on GitHub at https://github.com/ISISComputingGroup/IBEX/projects/1.
+There is also a long list of issues on GitHub that can be viewed at https://github.com/ISISComputingGroup/IBEX/issues. Please note, this is a rather long list and not very friendly to browse through unless you already know what you're looking for (e.g. a device name).
 
 
 Running IBEX
@@ -139,7 +139,7 @@ Scripting in IBEX
 In the scripting view I don't want the arguments when I autocomplete
 --------------------------------------------------------------------
 
-In the scripting console type `g.` will show a list of possible genie_python commands. If you select one of these or type to narrow down the possibilities, pressing return will autocomplete the method name including the parameters. However, sometimes you will not want all the parameters, so instead of pressing <return> press <crtl> + <return>, this will give only the function name without any parenthesis or arguments.
+In the scripting console type `g.` will show a list of possible genie_python commands. If you select one of these or type to narrow down the possibilities, pressing return will autocomplete the method name including the parameters. However, sometimes you will not want all the parameters, so instead of pressing <return> press <ctrl> + <return>, this will give only the function name without any parenthesis or arguments.
 
 When I load script I get an error complaining about unicodeescape
 -----------------------------------------------------------------

doc/Glossary.rst

@@ -50,7 +50,7 @@ Glossary
       For example, access to a Eurotherm temperature controller is controlled via an IOC process that provides
       Process Variable for the relevant control elements
 
-    OPI (OPerator Interface)
+    OPI (Operator Interface)
       An OPI is a user interface element of IBEX.  In essence, an OPI is a control panel for an individual device attached to an instrument.  It allows you to view and modify the PVs that define the state of the device.  For example, an OPI is displayed when you click on a device icon on a synoptic view.
 
     PV (Process Variable)

doc/IBEX-File-Paths-page.rst

@@ -11,11 +11,11 @@ The installation of IBEX is common for most instruments you shouldn't need to de
 
 * Configurations: ``C:\Instrument\Settings\config\<computer>\configurations`` this directory contains configuration, components and IOC specific configuration. The IOC specific configurations include:
 
-  - galil: ``galil`` galil motor configurations for all controllers, including jaws, axes and motion setpoint commands but not value
+  - Galil: ``galil`` Galil motor configurations for all controllers, including jaws, axes and motion setpoint commands but not value
   - motion setpoints: ``motionSetPoints`` the motion setpoints
   - refl: ``refl\config.py`` default reflectometry configuration
   - DAE tables: ``tables`` contains wiring, spectra and detector tables for the DAE
-  - TCB files: ``tcb`` contains the tcb files
+  - TCB files: ``tcb`` contains the TCB files
 
 * Common calibration files: ``C:\Instrument\Settings\config\common`` calibration files for instruments e.g. Eurotherm sensors
 

doc/device_specific/FZJ-Fermi-Chopper.rst

@@ -130,8 +130,8 @@ Crate does not respond / Crate responds infrequently
 An issue was seen when first commissioning the MAPS Fermi under EPICS. Symptoms were very odd:
 
 - Cannot communicate using VISA nor Asyn under EPICS
-- If chopper crate and instrument PC are power cycled, may need to run labview driver once before epics can talk. We are still not sure why this is.
-- If EPICS+Visa is subsequently run, it will upset the comms and will need to run the labview to "clear" the error
+- If chopper crate and instrument PC are power cycled, may need to run LabVIEW driver once before epics can talk. We are still not sure why this is.
+- If EPICS+Visa is subsequently run, it will upset the comms and will need to run the LabVIEW to "clear" the error
 
 **Shortened status command [Specific to Maps]**
 On MAPS, the crate's communications layer can fail, causing the device to ignore the standard polling command (``#0000000$``). To recover from this state, send the shortened command ``0$`` repeatedly until you get a response. The IOC should automatically do this whenever it detects no response to the standard command.

doc/device_specific/Lakeshore-340.md

@@ -12,6 +12,6 @@ They are loaded from the instrument config area for example on MUSR `Instrument\
 18,100 nA
 ```
 
-The file is read from top to bottom and the first temperature threshold that is greater than the temperature setpoint on the lakeshore 340 is the line that is selected. Subsequently, the IOC will wait for the temperature to reach the setpoint and then set the excitation to the value on the same file line as the matching temperature threshold. If no temperature threshold is found to match the file then the last excitation listed in the file will be set.
+The file is read from top to bottom and the first temperature threshold that is greater than the temperature setpoint on the Lakeshore 340 is the line that is selected. Subsequently, the IOC will wait for the temperature to reach the setpoint and then set the excitation to the value on the same file line as the matching temperature threshold. If no temperature threshold is found to match the file then the last excitation listed in the file will be set.
 
 If the set file contains invalid values or does not exist then the OPI will display this on the excitations tab. 

doc/how_to/Create-and-Manage-Configurations.rst

@@ -112,7 +112,7 @@ On clicking the ``Select PV`` button, IBEX will display a list of PVs available
 
    ``All IOCs`` to see PVs from all IOCs on your instrument (this can result in a very long list of PVs).
 
-   ``Active IOCs`` to see PVs only from IOcs that are currently running on your instrument.
+   ``Active IOCs`` to see PVs only from IOCs that are currently running on your instrument.
 
    ``Config IOCs`` to see PVs only from IOCs included in the current configuration.
 

doc/inst_specific/Engin-X-Sample-Stack.md

@@ -1,6 +1,6 @@
 # Engin-X Sample Stack
 
-The Engin X Sample Stack is controlled through IBEX but underneath IBEX link back into labview VIs from SECI hence why there are some special steps you need to use when looking at it. If you can't find the answer you are looking for in this page there is more information in the [developer wiki but beware this is quite low level](https://isiscomputinggroup.github.io/ibex_developers_manual/specific_iocs/motors/EnginX-Sample-Positioner.html).
+The Engin X Sample Stack is controlled through IBEX but underneath IBEX link back into LabVIEW VIs from SECI hence why there are some special steps you need to use when looking at it. If you can't find the answer you are looking for in this page there is more information in the [developer wiki but beware this is quite low level](https://isiscomputinggroup.github.io/ibex_developers_manual/specific_iocs/motors/EnginX-Sample-Positioner.html).
 
 ## Define a Motor Position on the Engin-X Sample Stack
 - Using a file explorer, go to the following location on `ndxenginx`: `C:\Labview Modules\Drivers\Galil DMC2280`

doc/inst_specific/Guidance-on-Writing-Scripts-for-the-Muon-Front-End.rst

@@ -10,7 +10,7 @@ Starting & Stopping Runs Remotely
 
 Ensuring the control machine has sufficient permission to begin a run
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The relevant code can be found in the github repository:
+The relevant code can be found in the GitHub repository:
 
 https://github.com/ISISComputingGroup/mfe_control_scripts
 

doc/introduction/What-Is-IBEX.rst

@@ -22,7 +22,7 @@ Using the IBEX GUI is the primary focus of this whole manual, as it is through t
 Introduction to genie_python
 ------------------------------------------------
 
-A full reference to genie_python is available `on github <https://isiscomputinggroup.github.io/genie/genie_python>`_ or internally `on shadow <http://shadow.nd.rl.ac.uk/genie_python/sphinx/genie_python.html>`_.
+A full reference to genie_python is available `on GitHub <https://isiscomputinggroup.github.io/genie/genie_python>`_ or internally `on shadow <http://shadow.nd.rl.ac.uk/genie_python/sphinx/genie_python.html>`_.
 
 Previous Instrument Control at ISIS
 ------------------------------------------------

doc/scripting/Alerts-on-Blocks.md

@@ -1,6 +1,6 @@
 # Alerts on Blocks
 
-Alerts can be configured on blocks using genie python, there is no GUI for this at the moment. An alert will trigger when a block is outside of the specified `lowlimit,highlimit` range for the specified `delay_out` time, it is like run control but rather than putting the DAE into WAITING a message (via sms text and/or email) is sent. When the value comes back in range, it must be in range for `delay_in` seconds until an in-range alert is sent.
+Alerts can be configured on blocks using genie python, there is no GUI for this at the moment. An alert will trigger when a block is outside of the specified `lowlimit,highlimit` range for the specified `delay_out` time, it is like run control but rather than putting the DAE into WAITING a message (via SMS text and/or email) is sent. When the value comes back in range, it must be in range for `delay_in` seconds until an in-range alert is sent.
 
 Note that this system is in addition to and independent of run control, it just uses some of the same underlying software. Alerts can be added to blocks that are not under run control, and both run control and alerts can bet set on the same block. The limits and delay times need not be the same for the run control and alert elements, so the instrument could be configured to go into a WAITING state when a block exceeded 100K but not send an alert until it exceeded 120K for a given length of time etc. (see below for how to set an alert on how long an instrument has been in a WAITING state)   
 
@@ -34,7 +34,7 @@ g.alerts.status()
 g.cset("block1", -50) # With above settings, message sent to say the block has gone out of range
 g.cset("block1", 0) # With above settings, message sent to say the block has gone back in range
 ```
-Alerts are saved across IBEX restarts, but the saving is not currently part of a configuration. The block related alert parameters will remain so long as the block exists (the email and sms parameters are always preserved), so you can change configuration and maintain an alert so long as the block continues to exists. If you change to a configuration where the block does not exist, then you lose those block specific alert settings. So it is best to create the blocks used for alerts as part of a common base component included in all configurations.
+Alerts are saved across IBEX restarts, but the saving is not currently part of a configuration. The block related alert parameters will remain so long as the block exists (the ``email`` and ``sms`` parameters are always preserved), so you can change configuration and maintain an alert so long as the block continues to exists. If you change to a configuration where the block does not exist, then you lose those block specific alert settings. So it is best to create the blocks used for alerts as part of a common base component included in all configurations.
 
 Alerts, like run control, are normally set on floating point (or integer) value blocks. They can, however, be used on some "state" items that are symbolic names mapped to integers (enums). One example of this is the instrument state (SETUP=1,RUNNING=2,PAUSED=3,WAITING=4,VETOING=5) so if a block called `RunState` is attached to the process variable `IN:myinst:DAE:RUNSTATE` then
 ```python