TOPAZ config file generator

Notebook name: TOPAZ_config_generator.ipynb

Start the Notebook

If you need help accessing this notebook, check the How To > Start the python notebooks tutorial.

First Time Look

If you are using the notebook for the first time, it should look like this

Define IPTS

Starting from the top SHIFT + ENTER the cells in order to run them. The 4th cell will ask you to select the IPTS of your experiment.

Initialize Parameters Using Config File (Optional)

In case you want to initialize the content of all the widgets by a config file you created in the past, you can simply select that config file.

Run All Cells at Once

Select the next cell and click Cell > Run All Below.

File or Folder Selection Tool

In order to select a file or a folder you need to know the following:

  • one dot (.) means current folder
  • 2 dots (..) means above folder
  • click select to validate your file or folder selection
  • selection made will be display above the selection tool

Widget Interaction

You will find that some of the widgets display depends on your input in other widgets. This has been implemented to help you in your choice of parameters.

Advanced Options

Instrument scientists and super users can have access to advanced options by entering a pasword in the Advanced Options cell.

Create Config File

And finally, re-run the last cell Export the Config File in order to produce the config file. If any information is missing, a text will show you what is missing. Just click on this link to quickly jump to the widgets in the notebook.

If nothing is missing, the full path to the config file created will be displayed!

For advanced users who entered the instrument password, they will have a preview of the config file when creating the configuration file.

Run Reduction

The next cell will build up the command line you will need to copy/paste into a terminal. To do so

  • Copy the command line green text using Right click + Copy …
  • click the terminal icon at the top of the desktop
  • Paste the text
  • hit ENTER