$$

GetIPTS v1

Summary

Extracts the IPTS number from a run using FileFinder

Properties

Name	Direction	Type	Default	Description
RunNumber	Input	number	Mandatory	Extracts the IPTS number for a run
Instrument	Input	string		Empty uses default instrument. Allowed values: [‘’, ‘ARCS’, ‘BSS’, ‘CHESS’, ‘CNCS’, ‘CORELLI’, ‘DAS’, ‘EQSANS’, ‘HYS’, ‘MANDI’, ‘NOM’, ‘NOW4’, ‘PG3’, ‘REF_L’, ‘REF_M’, ‘SEQ’, ‘SNAP’, ‘SWANS’, ‘TOPAZ’, ‘USANS’, ‘VENUS’, ‘VIS’, ‘VULCAN’, ‘ZEEMANS’, ‘CG2’, ‘CG2’, ‘CG3’, ‘HB1’, ‘HB1A’, ‘HB2A’, ‘HB2B’, ‘HB2C’, ‘HB2D’, ‘HB3’, ‘HB3A’, ‘HIRESSANS’]
ClearCache	Input	boolean	False	Remove internal cache of run descriptions to file paths
Directory	Output	string

Description

This returns a string the full path to the IPTS shared folder to allow for saving of files in accessible user folders (e.g. shared).

The algorithm has a cache of runnumbers that is stores while mantid is running. This cache can be reset using the ClearCache argument or by restarting mantid.

Warning

This only works at ORNL.

Usage

Example - IPTS directory for default instrument

This will vary based on your default instrument.

print(GetIPTS(12345))

Output:

/SNS/PG3/IPTS-8111/

Example - IPTS directory for specific instrument

Being explicit about the instrument gives the same result for everyone.

print(GetIPTS(Instrument='NOM', RunNumber=12345))

Output:

/SNS/NOM/IPTS-8687/

Categories: AlgorithmIndex | Utility\ORNL

Source

Python: GetIPTS.py