| Line 9 was replaced by line 9 |
| - For a transition period [SEA|Sea] is still used for all devices not yet migrated to Frappy. Today (spring 2021) still most |
| + For a transition period [SEA|Sea] is still used for all devices not yet migrated to Frappy. Today (spring 2022) still most |
| Line 14 was replaced by line 14 |
| - Currently (April 2021), the following instruments running NICOS are supported to access sample environment: |
| + Currently (April 2022), the following instruments running NICOS are supported to access sample environment: |
| Line 16 was replaced by line 16 |
| - * __FOCUS, SANS-I, HRPT__ |
| + * __HRPT, ZEBRA, TASP, EIGER, CAMEA, FOCUS, SANS-I, AMOR, BOA__ |
| Line 24 was replaced by line 24 |
| - By default a setup 'frappy' is loaded providing the following commands: |
| + By default a setup 'frappy' is loaded providing the following commands:\\ |
| Removed line 26 |
| - |
| Lines 28-33 were replaced by lines 27-32 |
| - frappy_main('<main cfg>') # change main SE configuration (e.g. cryostat) |
| - frappy_stick('<stick cfg>') # change sample-stick configuration |
| - frappy_stick('') # remove stick |
| - frappy_main('') # remove main SE apparatus |
| - frappy_main() # show the current SE configuration |
| - frappy_addons(...) # similar to above, for additional equipment not covered by main/stick |
| + frappy('<main cfg>') # change main SE configuration (e.g. cryostat) |
| + frappy('<main cfg>', '<stick cfg>') # change main and sample-stick configuration |
| + frappy(stick='<stick cfg>') # change stick only |
| + frappy('') # remove main SE apparatus including stick |
| + frappy() # show the current SE configuration |
| + frappy(addons=...) # similar to above, for additional equipment not covered by main/stick |
| At line 36 added 8 lines. |
| + ''note: use {{AddSetup('frappy')}} if the setup is not yet loaded'' |
| + |
| + |
| + !! Test integration of SE into NICOS |
| + |
| + For testing there are 2 simulated main devices 'cryosim' and 'magsim' available. Please check with them if |
| + temperatures and magnetic field values are saved in your datafile, and other things like temperature or |
| + magnetic field scans. |
| Line 46 was replaced by line 53 |
| - * __Ts__: the sample temperature potentially readonly |
| + * __Ts__: the sample temperature, potentially readonly |
| Line 50 was replaced by lines 57-58 |
| - The aliases above (except T) are automatically put into the envrionment list, and will be saved in the data file. |
| + The aliases above (except T) are automatically put into the envrionment list, and should be saved in the data file. |
| + Typically, either T and Tr or T and Ts point to the same real device. |
| At line 71 added 32 lines. |
| + |
| + ! How to Restart a Frappy server |
| + |
| + If a sample environment device is not working properly, for example due to communication |
| + problems, it might be helpful to stop and restart the frappy server: |
| + {{{ |
| + frappy('') # stop main and stick frappy servers |
| + frappy('<main cfg>', '<stick cfg>') # start main and stick frappy servers |
| + }}} |
| + |
| + If the problem is related to a device on the stick or addons, you will need the commands frappy_stick or frappy_addons. |
| + |
| + ! How do I configure to use the sample stick rotation instead of the sample table for omega? |
| + |
| + With vertical field cryomagnets, typically the stick rotation should be used instead of the |
| + standard sample table for omega. In this case (currently configured on ZEBRA and TASP), |
| + the frappy_main setups should contain a device __se_om__ for the stick rotation. This is |
| + automatically assigned to the device used for omega. |
| + |
| + ||Instrument || name of omega || name of sample table |
| + |ZEBRA | om | om_raw |
| + |TASP | a3 | a3_st |
| + |CAMEA | a3 | som |
| + |
| + On horizontal field magnets, the stick rotation is called __om_stick__, and is |
| + not automatically assigned to omega. In both cases, an alias __dom__ is assigned to |
| + either __se_om__ or __se_stickrot__, whatever is present. |
| + |
| + To change this behaviour, it is possible to assign another device to the alias, e.g. |
| + |
| + {{om.alias = se_stickrot}} |
| + |
LIN