Skip to content

Commit d8a4449

Browse files
committed
fixing some typos and better text alignment
Signed-off-by: Jose Borreguero <borreguero@gmail.com>
1 parent 4ddc935 commit d8a4449

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,22 @@ A minimal configuration to specify using nightly builds of mantid installed in a
1010
"CONDA_ENV": "mantid-dev"
1111
}
1212
```
13-
For testing a configuration file can be supplied as a command line argument when running
13+
For testing, a configuration file can be supplied as a command line argument when running
1414
```shell
1515
$ python scripts/livereduce.py ./livereduce.conf
1616
```
17-
If the instrument is not defined in the configuration file (default is `/etc/livereduce.conf`) the software will ask mantid for the default instrument using `mantid.kerel.ConfigService.getInstrument()` ([docs](https://docs.mantidproject.org/nightly/api/python/mantid/kernel/ConfigServiceImpl.html#mantid.kernel.ConfigServiceImpl.getInstrument)).
18-
The default instrument is controlled in the [mantid properties files](https://docs.mantidproject.org/nightly/concepts/PropertiesFile.html) and is typically defined in `/etc/mantid.local.properties`.
17+
If the instrument is not defined in the configuration file,
18+
the software will ask mantid for the default instrument using
19+
`mantid.kerel.ConfigService.getInstrument()` ([docs](https://docs.mantidproject.org/nightly/api/python/mantid/kernel/ConfigServiceImpl.html#mantid.kernel.ConfigServiceImpl.getInstrument)).
20+
The default instrument is controlled in the [mantid properties files](https://docs.mantidproject.org/nightly/concepts/PropertiesFile.html)
21+
and is typically defined in `/etc/mantid.local.properties`.
1922

2023

2124
Managing the service
2225
--------------------
2326

2427
If run from inside `systemctl`, use the standard commands for starting and stopping it.
28+
2529
```shell
2630
sudo systemctl start livereduce
2731
sudo systemctl stop livereduce
@@ -56,7 +60,7 @@ The `livereduce.py` script manages live data reduction using the Mantid framewor
5660
logging, handles signals for graceful termination, reads the configuration JSON, and
5761
manages live data processing with Mantid's StartLiveData and MonitorLiveData algorithms. The
5862
script monitors memory usage and restarts the live data processing if memory limits are exceeded.
59-
It uses pyinotify to watch for changes in configuration and processing scripts, restarting the
63+
It uses `pyinotify` to watch for changes in configuration and processing scripts, restarting the
6064
live data processing as needed. The script relies on instrument-specific processing scripts for data
6165
accumulation and reduction, namely:
6266

0 commit comments

Comments
 (0)