top of page
Writer's pictureSharon McTaggart

ilumr Software Update


ilumr update graphic


We've been working on an ilumr software update this month and are excited to share it with you!


So What's New?


Our goal for this software update was to make it easier to set up experiments in Jupyter notebooks. To achieve this, we have created a new experiment library. We have also updated our Lab Courseware to to use this experiment library.


New Experiment Library


The new experiment library handles the execution of pulse sequences and data plotting. You can view the API reference for this library here: Read the Docs. The ilumr-courseware repository is a great place to start for usage examples.


Some key features of this experiment library are:


  • State Preservation: The state of notebook experiments' inputs and plots is saved and loaded automatically, so you can resume where you left off.

  • Auto-generated Input Widgets: Easily create input widgets for pulse sequence parameters.

  • Interactive Plots: The update includes a library of commonly used plots:

    • Signal

    • Spectrum

    • 1D Image

    • 2D Image

    • Line

    • Scatter

    • Wobble (for calibration dashboards)

  • Progress Bar: The new progress bar displays the estimated time a pulse sequence will take to run and updates the time as the experiment progresses.

  • Auto Layout: Plots, buttons, user inputs, and the progress bar are laid out automatically.

  • Data Saving: Notebook experiments are now equipped with a "save" button that saves the sequence data and parameters to a hdf5 file. The new "auto save" toggle button allows for automatic data saving each time the experiment runs.

  • Debugging and Error Reporting: Status logs and error messages with full tracebacks are now displayed in the new status card.


dashboards showing 2D kspace plot and image
New Experiment Layout

Updated Courseware


The current labs in our MRI Fundamentals course have all been rebuilt using our new experiment library. These lab scripts provide a great example of how the new experiment library can be used to create a wide range of novel experiments.

Inline dashboard and student instructions
MRI Fundamentals Lab One

How to Update your ilumr


Updating your ilumr is easy!

  • Plug ilumr into a router with internet access using an ethernet cable.

  • Connect to ilumr via wifi or its IP address assigned by the router.

  • Open the "Admin" Dashboard App.

  • Click the "Enable Shutdown/Update" checkbox.

  • Press the blue "Update" button at the bottom of the dashboard.

  • A "Server Connection Error" will show as the JupyterLab server is stopped during the update process.

  • Leave ilumr powered until JupyterLab restarts. This will take about 10 minutes, depending on the internet speed. You may need to reload the page to check if it is done.


visual guide for how to update ilumr
Update options in Admin Dashboard

Join the Discussion


If you have any questions or run into any problems, we'd love to hear about it.

forum logo

Our forum is a great place to discuss topics with our staff and other ilumr users. If you need a hand building experiments using the new experiment library or want to report a bug, don't hesitate to reach out in the Q&A topic!











45 views

Recent Posts

See All

Comments


Commenting has been turned off.
bottom of page