Table of Contents
Checks the Mantid instrument repository against the local instrument files, and downloads updates as appropriate.
Name | Direction | Type | Default | Description |
---|---|---|---|---|
ForceUpdate | Input | boolean | False | Ignore cache information |
FileDownloadCount | Output | number | The number of files downloaded by this algorithm |
This algorithm connects with the cloud based Mantid Instrument Definition Repository and downloads any updated instrument files for use within Mantid.
This algorithm is normally run on startup of Mantid for official installed releases of Mantid from version 3.3 onwards.
The code is configured using he following Mantid.Property, or Mantid.User.Property keys.
The following may be logged at Notice
The Mantid Instrument Definition Repository is currently a directory within the Mantid code repository on Github. https://github.com/mantidproject/mantid
The instrument files within Mantid can be accessed in three locations.
When running the algorithm the processing takes the following steps.
Example
updatedFileCount = DownloadInstrument()
print("The number of files updated was " + str(updatedFileCount))
Output:
The number of files updated was ...
Categories: AlgorithmIndex | DataHandling\Instrument
C++ source: DownloadInstrument.cpp (last modified: 2019-07-19)
C++ header: DownloadInstrument.h (last modified: 2018-10-05)