Overview
On ilumr, pulse sequences are defined in python program files (.py) and run in notebooks (.ipynb). As an optional step, you can plot your pulse sequence file offline before running it on ilumr.
Program File (.py)
This file is typically used to:
- Define the pulse sequence parameters
- Set hardware options
- Define the data layout
- Calculate the timing parameters
- Send commands to the ilumr hardware using yield statements
ilumr’s inbuilt pulse sequence program files can be found in system → programs. The system folder is read only. If you want to modify an existing pulse sequence file you will need to copy the file into a new folder.
If you’re new to pulse programming on the ilumr, the Writing Custom Pulse Sequence Programs documentation on our Read the Docs page is a great place to get started.
Pulse Sequence Plotting Tool
The offline pulse sequence plotting tool is a useful way to visualize your program files and make sure your timing parameters have been set correctly. You can visit our previous forum post to download the beta version of this tool.
Running the Experiment in a Notebook (.ipynb)
This file is typically used to:
- Load the pulse sequence program file
- Load any relevant global variables
- Set the pulse sequence parameters
- Run the pulse sequence
- Process the data
To create a new notebook file: navigate to your desired location in the file structure, right click inside a folder, then click “New Notebook”.
The Running a Pulse Sequence documentation on our Read the Docs page walks you through the process of setting up an experiment in a notebook.
Interactive widgets, data processing, and plotting libraries can be used to customize how users interact with your pulse sequence’s inputs and outputs. Our blog post, Getting Started with Jupyter Notebooks, has links to the documentation for each of the python libraries that come preinstalled on ilumr.