Hardware configuration new - josalggui/MaRGE GitHub Wiki

System Configuration Notes

This section describes how to set up the system when running MaRGE for the first time. Before proceeding, ensure that the Red Pitaya and the Host computer are configured properly by following this guide.

First Launch of MaRGE

When running MaRGE for the first time, the session window is displayed. For a detailed description of the GUI, go to this link.

This window contains three key widgets:

  1. Scanner Checks – Displays missing configuration files.
  2. Information Area – Shows real-time system information.
  3. Session and Hardware Tabs – Allows users to configure session parameters.

On the initial launch, you will notice:

  1. Errors displayed in the information area.
  2. Unchecked scanner checks.
  3. and buttons disabled.

These issues stem from missing configuration files. This guide explains how to set them up properly.

Configuring the System Files

MaRGE requires the following eight elements to be configured upon first use:

  1. Projects
  2. Study Cases
  3. Console
  4. Gradient Hardware
  5. RF Configuration
  6. Red Pitaya IPs
  7. RF Coils
  8. Other Hardware and Software Components

Important

To establish communication with the scanner hardware, at minimum the following parameters must be configured:

  • In the Console tab, add the Red Pitaya IP address corresponding to your scanner.
  • In the Others tab, set a valid Bash path for your operating system.

Without these two settings, MaRGE cannot connect to the Red Pitaya and scanner control will not be available.

Setting Up Projects and Study Cases

To configure a project or study case:

  1. Click on the Project/Study box.
  2. The box will be empty initially. Click Add/Delete to create a new entry.
  3. A pop-up window appears where you can type the project/study name.
    • Entering an existing name deletes that project/study.

Once added, clicking in the session toolbar should check Projects and Study Cases.

Setting up the Console and Red Pitayas

To configure the console and Red Pitayas:

  1. Navigate to the Console tab.

  1. Configure MaRCoS settings:
    • Red Pitaya Model: rp-122 or rp-125 (only rp-122 working now)
    • Gradient Board Model: gpa-fhdo or ocra1
  2. Add the Red Pitaya IP (configured with a static IP):
    • Enter the IP in the IP box and click Add button.
    • This step is mandatory to allow MaRGE to communicate with the scanner hardware
    • The new Red Pitaya appears in the console tab.
    • Add multiple Red Pitayas if needed (e.g., for MIMO applications, under development).
  3. Click Save and then to finalize the setup.
    • MaRCoS and RP IPs should now be checked.

RF Configuration and RF Coils

The RF tab is used to configure the system's RF parameters and define the available RF coils.

  1. Go to the RF tab.

  1. Configure the RF system parameterss:
    • Gyromagnetic ratio
    • Larmor frequency
    • RF dead time
    • LNA gain (used to estimate the noise floor in the baseband)
  2. Add the available RF coils:
    • Enter the RF coil ID
    • Enter the RF efficiency in units of rad/s/a.u.
    • Click Add to include the coil in the configuration.
  3. Save the configuration
    • Click Save and Update.
    • The RFs and RF Coils should now appear as configured (checked).
  4. Verfiy the configuration:
    • The new added RF coils should now be available in the RF coil selection list of the Session tab.

Note: RF efficiency is given in rad/s/a.u., where a.u. stands for arbitrary units. An RF amplitude of 1 a.u. corresponds to the maximum amplitude delivered by the Red Pitaya transmit chain. The actual RF voltage, RF power, and resulting $B_1$ field depend on the gain of the RF amplifier and the characteristics of the RF coil. Therefore, RF amplitudes are specified in normalized units rather than physical units. The RF efficiency parameter converts these normalized amplitudes into the corresponding nutation rate ($\gamma B_1$).

Setting up Gradients and Other Hardware

In the Gradients and Others tabs:

  1. Complete the configuration fields based on your hardware setup.
  2. Click Save and then Update.

Once all elements are configured:

  • All checks should be marked.
  • The and buttons become available.

IMPORTANT

Bash path:

A valid Bash executable or terminal command must be specified for MaRGE to communicate with the Red Pitaya.

Operating System Bash Path
Windows C:/path/to/git_bash.exe
Ubuntu 22.04 LTS / 24.04 LTS gnome-terminal
Ubuntu 26.04 LTS ptyxis by default, but gnome-terminal recommended
Other Linux distributions Use the terminal emulator available on your system (e.g., konsole, xfce4-terminal, mate-terminal, etc.), but it is reommended to install and use gnome-terminal

Together with the Red Pitaya IP address configured in the Console tab, this is the minimum configuration required to access the scanner hardware.

Tyger server:

  • You need to have tyger configured in your PC. Check here
  • Specify the host of your Tyger server, if applicable.

Each time MaRGE is opened, the configuration is automatically loaded, allowing the user to proceed directly to the main window. The configuration can be modified and updated at any time to run the scanner with new parameters.