ISIS direct reduction script description. - Revision history

Alex Buts: /* Overview */

2020-10-19T17:02:36Z

Overview

Alex Buts: /* Overview */

2020-10-19T16:59:58Z

Overview

Alex Buts: /* Overview */

2017-09-13T15:10:15Z

Overview

Alex Buts: /* Reduction script files and their purpose */

2017-08-16T17:47:03Z

Reduction script files and their purpose

Alex Buts: /* Reduction script files and their purpose */

2017-08-16T17:38:07Z

Reduction script files and their purpose

Alex Buts: /* Reduction script files and their purpose */

2017-08-16T17:36:24Z

Reduction script files and their purpose

Alex Buts: /* Overview */

2017-08-16T13:21:46Z

Overview

Alex Buts: /* Reduction script files and their purpose */

2016-10-19T16:06:21Z

Reduction script files and their purpose

Alex Buts: /* Reduction script files and their purpose */

2016-10-19T16:05:32Z

Reduction script files and their purpose

Alex Buts: /* Reduction script files and their purpose */

2016-10-19T16:04:24Z

Reduction script files and their purpose

@@ Line 14: / Line 14: @@
 | MARI:
 |[https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MARI/template_mari.py template_mari.py]
-|[https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MARI/MARIReduction_Sample.py MARIReduction_Sample.py]
+|[https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MARI/MARIReduction_SampleAbs.py MARIReduction_Sample.py]
 |[https://github.com/mantidproject/mantid/blob/master/instrument/MARI_Parameters.xml MARI_Parameters.xml]
 |[https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MARI/USER_Files_description.xml MARI User settings ]

@@ Line 27: / Line 27: @@
 | ---
 | [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MERLIN/MERLINReduction_Sample.py MERLINReduction_Sample.py]
-| [https://github.com/mantidproject/mantid/blob/master/instrument/MERLIN_Parameters_2017_2.xml MERLIN_Parameters.xml]
+| [https://github.com/mantidproject/mantid/blob/master/instrument/MERLIN_Parameters_2018_03.xml MERLIN_Parameters.xml]
 | [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MERLIN/USER_Files_description.xml MERLIN User settings]
 |-

@@ Line 27: / Line 27: @@
 | ---
 | [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MERLIN/MERLINReduction_Sample.py MERLINReduction_Sample.py]
-| [https://github.com/mantidproject/mantid/blob/master/instrument/MERLIN_Parameters_after2013_4.xml MERLIN_Parameters.xml]
+| [https://github.com/mantidproject/mantid/blob/master/instrument/MERLIN_Parameters_2017_2.xml MERLIN_Parameters.xml]
 | [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MERLIN/USER_Files_description.xml MERLIN User settings]
 |-

@@ Line 100: / Line 100: @@
     prop = PropertyManager.property_name
-after ''PropertyManager'' has been instantiated somewhere in the python workspace (as part of the reduction script, see below) e.g.:
+When ''PropertyManager'' has been instantiated somewhere in the python workspace (as part of the reduction script, see below) the call like:
-  is_multirep  = PropertyManager.incident_energy.multirep_mode()   Return true if energy is defined as list of energies and false otherwise (multirep mode)
+  is_multirep  = PropertyManager.incident_energy.multirep_mode()   Returns true if energy is defined as list of energies and false otherwise (multirep mode)
 or:
    run_nuber = PropertyManager.sample_run.run_number()    Get run number for defined sample run.

@@ Line 109: / Line 109: @@
 Note the difference between getting the whole property above, allowing access to the properties methods, and getting access to property value within ''PropertyManager'' instance (PropertyManager instantiated in DirectEnergyConversion as prop_man):
    dc = DirectEnergyConversion('MER')
-   dc.prop_man.sample_run = 2034
+   dc.prop_man.sample_run = 2034  # Accessing the PropertyManager instance '''prop_men''' defined within DirectEnergyConversion class
    print "Sample run number is: ",dc.prop_man.sample_run
 prints:

@@ Line 35: / Line 35: @@
 | [https://github.com/mantidproject/mantid/blob/master/instrument/LET_Parameters_dr1to12.xml LET_Parameters.xml]
 | [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/LET/USER_Files_description.xml LET User settings]
 |}

@@ Line 69: / Line 69: @@
 |-
 | [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/PropertyManager.py ''PropertyManager.py'']
-| When workspace is loaded, Mantid reads appropriate '''InstrumentName_Parameters.xml''' file and interprets all records, found in this file as instrument parameters with appropriate names. This python class, together with [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/NonIDF_Properties.py ''NonIDF_Properties''] class get access to these parameters and transforms them into ''DirectEnergyConversion'' process properties. This class also responsible for processing user input and all other ''DirectEnergyConversion'' properties, and provides input data and settings for [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/DirectEnergyConversion.py ''DirectEnergyConversion'']. To do that ''PropertyManager'', together with [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/NonIDF_Properties.py  NonIDF_Properties] class instantiates classes found in three other files, namely: [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/PropertiesDescriptors.py ''PropertiesDescriptors.py''],[https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/RunDescriptor.py ''RunDescriptor.py'']  and [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/ReductionHelpers.py ''ReductionHelpers.py''].
+| When workspace is loaded, Mantid reads appropriate '''InstrumentName_Parameters.xml''' file and interprets all records, found in this file as instrument parameters with appropriate names. This python class, together with [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/NonIDF_Properties.py ''NonIDF_Properties''] class get access to these parameters and transforms them into ''DirectEnergyConversion'' process properties. This class is also responsible for processing user input and all other ''DirectEnergyConversion'' properties, and provides input data and settings for [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/DirectEnergyConversion.py ''DirectEnergyConversion'']. To do that ''PropertyManager'', together with [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/NonIDF_Properties.py  NonIDF_Properties] class instantiates classes found in three other files, namely: [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/PropertiesDescriptors.py ''PropertiesDescriptors.py''],[https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/RunDescriptor.py ''RunDescriptor.py'']  and [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/ReductionHelpers.py ''ReductionHelpers.py''].
 |}