Difference between revisions of "ISIS direct reduction script description."
| Line 16: | Line 16: | ||
|[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_Sample.py MARIReduction_Sample.py] | ||
|[https://github.com/mantidproject/mantid/blob/master/instrument/MARI_Parameters.xml MARI_Parameters.xml] | |[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 USER_Files_description.xml] |
|- | |- | ||
| MAPS: | | MAPS: | ||
| Line 22: | Line 22: | ||
|[https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MAPS/MAPSReduction_Sample.py MAPSReduction_Sample.py] | |[https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MAPS/MAPSReduction_Sample.py MAPSReduction_Sample.py] | ||
|[https://github.com/mantidproject/mantid/blob/master/instrument/MAPS_Parameters.xml MAPS_Parameters.xml] | |[https://github.com/mantidproject/mantid/blob/master/instrument/MAPS_Parameters.xml MAPS_Parameters.xml] | ||
| − | | | + | |[https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MAPS/USER_Files_description.xml USER_Files_description.xml] |
|- | |- | ||
| MERLIN: | | MERLIN: | ||
| − | | | + | | --- |
| [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MERLIN/MERLINReduction_Sample.py MERLINReduction_Sample.py] | | [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_after2013_4.xml MERLIN_Parameters.xml] | ||
| − | | | + | | [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/MERLIN/USER_Files_description.xml USER_Files_description.xml] |
|- | |- | ||
| LET: | | LET: | ||
| − | | | + | | --- |
| [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/LET/LETReduction_Sample.py LETReduction_Sample.py] | | [https://github.com/mantidproject/scriptrepository/blob/master/direct_inelastic/LET/LETReduction_Sample.py LETReduction_Sample.py] | ||
| [https://github.com/mantidproject/mantid/blob/master/instrument/LET_Parameters_dr1to12.xml LET_Parameters.xml] | | [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 USER_Files_description.xml] |
|} | |} | ||
| − | The ''teplate_instrument_name.py'' file and '' | + | The '''teplate_instrument_name.py''' file and '''InstrumentReduction_Sample.py''' from the column two and three above are processed by [https://github.com/mantidproject/mantid/blob/master/scripts/Inelastic/Direct/ISISDirecInelasticConfig.py MantidConfigurationScript], which replaces the strings, specified in correspondent ''User Settings'' file and produces simple and full reduction scripts for users. |
Simple reduction script created for users who prefer old functional interface existing in '''[https://github.com/mantidproject/scriptrepository/tree/master/direct_inelastic/ISIS/qtiGenie qtiGenie]''' and '''Libisis'''. It highlights only the parameters user needs to change during an experiment and allows users to separate all parameters, necessary to reduce data and user's parameters in different files. User parameters are usually the ''run number'' or ''list of run numbers'' to process, run ''number for a white beam vanadium run'', ''energies'' user is interested in and ''energy binning''. There are couple of other parameters, directly related to the experiment in progress. These parameters are better described in the script itself. | Simple reduction script created for users who prefer old functional interface existing in '''[https://github.com/mantidproject/scriptrepository/tree/master/direct_inelastic/ISIS/qtiGenie qtiGenie]''' and '''Libisis'''. It highlights only the parameters user needs to change during an experiment and allows users to separate all parameters, necessary to reduce data and user's parameters in different files. User parameters are usually the ''run number'' or ''list of run numbers'' to process, run ''number for a white beam vanadium run'', ''energies'' user is interested in and ''energy binning''. There are couple of other parameters, directly related to the experiment in progress. These parameters are better described in the script itself. | ||
Revision as of 16:40, 15 February 2016
Overview
All ISIS direct inelastic reduction scripts have similar interface and layout, with only parameters different for different instruments. Some parameters change from one cycle and sometimes one experiment to another but most of them are instrument specific and changes only when instrument is modified. Instrument scientists prepare sample Mantid python reduction scripts, which are then automatically distributed to Isiscompute users according to the rules described here.
From the links below one can retrieve resent versions of these scripts and their default reduction parameters stored in XML files, namely:
| Instrument | Simple reduction script | Full reduction script | Default reduction parameters | User Settings file |
| MARI: | template_mari.py | MARIReduction_Sample.py | MARI_Parameters.xml | USER_Files_description.xml |
| MAPS: | template_maps.py | MAPSReduction_Sample.py | MAPS_Parameters.xml | USER_Files_description.xml |
| MERLIN: | --- | MERLINReduction_Sample.py | MERLIN_Parameters.xml | USER_Files_description.xml |
| LET: | --- | LETReduction_Sample.py | LET_Parameters.xml | USER_Files_description.xml |
The teplate_instrument_name.py file and InstrumentReduction_Sample.py from the column two and three above are processed by MantidConfigurationScript, which replaces the strings, specified in correspondent User Settings file and produces simple and full reduction scripts for users.
Simple reduction script created for users who prefer old functional interface existing in qtiGenie and Libisis. It highlights only the parameters user needs to change during an experiment and allows users to separate all parameters, necessary to reduce data and user's parameters in different files. User parameters are usually the run number or list of run numbers to process, run number for a white beam vanadium run, energies user is interested in and energy binning. There are couple of other parameters, directly related to the experiment in progress. These parameters are better described in the script itself.
Simple reduction script is then imports full reduction script, which sets up the parameters specific to a cycle and may be to an experiment. After that the advanced script picks up all other parameter's default values from the appropriate xml file and runs the reduction algorithms itself.
User may work directly with full reduction script as this one has two sections, which contain simple and advanced parameters, so to set up small number of simple parameters in a separate script or to set up all parameters together in one big script is the matter of personal choice.
Within the advanced reduction script user can find the iliad function, which is actually used by the simple reduction script