Rogue Docker image for the SMuRF project

Description

This docker image, named smurf-rogue contains all the base tools used by the SMuRF project.

It is based on ubuntu 24.04, and contains:

• Basic system tools
• python3
• Python3 modules
  • ipython
  • numpy
  • pyepics
• SLAC IPMI wrappers
• SLAC's FirmwareLoader and ProgramFPGA script
• smurftestapps repository
• Rogue Version 6

Source code

Rogue source code is checked out for the SLAC's github repository https://github.com/slaclab/rogue.

The IPMC package containing source code, libraries, and binaries was taken from SLAC's version, hosted internally. The package was manually copied into this repository in the form of a tarball. The FirmwareLoader binary was taken from SLAC's version, hosted internally. The binary was manually copied into this repository in the form of a tarball.

Building the image

When a tag is pushed to this github repository, a new Docker image is automatically built and pushed to this package. The resulting docker image is tagged with the same git tag string (as returned by git describe --tags --always).

Usage

In your Dockerfile

FROM ghcr.io/slaclab/smurf-rogue:<TAG>

In the commandline

docker run -ti --rm --name smurf-roguev6 ghcr.io/slaclab/smurf-rogue:TAG

• TAG: The tag of the Docker file, which is the same as this repository's tags.

Building the image locally

To test without releasing, can build locally by running

docker build . -t smurf-rogue

on the command line in the top smurf-base-docker repository directory. If successful, can enter a bash session in the new image via

docker run -ti --rm --name smurf-rogue smurf-rogue:latest

Use the container to connect remote rogue GUIs

The docker image includes a script called connect_remote_gui.py (available in the PATH) which can be used to connect a rogue GUI to a remote server.

This are the available options:

usage: connect_remote_gui.py [-h] [--host HOST_NAME] [--slot {2,3,4,5,6,7}]
                             [--atca-monitor] [--pcie] [--port PORT_NUMBER]

optional arguments:
  -h, --help            show this help message and exit
  --host HOST_NAME      Hostname where the server application is running.
                        Defaults to 'localhost'.
  --slot {2,3,4,5,6,7}  Connect a GUI to pysmurf server running on a AMC
                        carrier, located in this slot number. The port number
                        used is "9000+3*slot_number". Ignored if option "--
                        port" is used.
  --atca-monitor        Connect a GUI to an atca_monitor rogue server. The
                        port number used is 9100. Ignored if options "--slot"
                        or "--port" are used.
  --pcie                Connect a GUI to a PCIe card rogue server. The port
                        number used is 9102. Ignored if options "--slot", "--
                        port" or "--atca-monitor" are used.
  --port PORT_NUMBER    Connect to a rogue application running on a non-
                        predefined port number.

The server application must be already running before you try to connect a GUI to it. The remote server is identified by the hostname where it is running and the port number it is using. All application types have predefined default port numbers:

• A pysmurf server application, running on an AMC carrier, uses by default port number 9000 + 3 * slot_number,
• an atca-monitor application uses by default port number 9100,
• a pcie card application uses by default port number 9102.

You can also use a specific port number if needed, using the --port option. The hostname used by default is localhost, but you can specify a different one using the --host option.