Difference between revisions of "ISIS direct reduction script description."
| Line 39: | Line 39: | ||
The '''teplate_instrument_name.py''' and '''InstrumentReduction_Sample.py''' files referenced in 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 Description'' file (Column 5) and produces [http://shadow.nd.rl.ac.uk/wiki/idr/index.php/Automatic_user_configuration simple and full reduction scripts for users]. | The '''teplate_instrument_name.py''' and '''InstrumentReduction_Sample.py''' files referenced in 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 Description'' file (Column 5) and produces [http://shadow.nd.rl.ac.uk/wiki/idr/index.php/Automatic_user_configuration simple and full reduction scripts for users]. | ||
| − | Simple reduction script created for users who prefer old functional interface | + | Simple reduction script created for users who prefer old functional interface used by '''[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'' the 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. | 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. | ||
| Line 45: | Line 45: | ||
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. | 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. | ||
| − | + | For instruments, where simple reduction script is present, user can find the '''iliad''' function, used by the simple reduction script inside the advanced reduction script. | |
Revision as of 15:15, 16 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 Description file |
| MARI: | template_mari.py | MARIReduction_Sample.py | MARI_Parameters.xml | MARI User settings |
| MAPS: | template_maps.py | MAPSReduction_Sample.py | MAPS_Parameters.xml | MARI User settings |
| MERLIN: | --- | MERLINReduction_Sample.py | MERLIN_Parameters.xml | MERLIN User settings |
| LET: | --- | LETReduction_Sample.py | LET_Parameters.xml | LET User settings |
The teplate_instrument_name.py and InstrumentReduction_Sample.py files referenced in column two and three above are processed by MantidConfigurationScript, which replaces the strings, specified in correspondent User Settings Description file (Column 5) and produces simple and full reduction scripts for users.
Simple reduction script created for users who prefer old functional interface used by 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 the 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.
For instruments, where simple reduction script is present, user can find the iliad function, used by the simple reduction script inside the advanced reduction script.