1. occam-login

Description:

This command let you sign in to the internal occam registry: if you own more than an occam account, then you can access to different private registry switching between them with occam-login.

Usage:

occam-login

2. occam-run

Description:

This command let you run computation on the OCCAM nodes.

Usage:

occam-run [-n nodename] [-i] [-x] [-p PORT] IMAGE_NAME [CMD] [PARAMETERS]

where:

  • -n = computation node name
  • -i = interactive mode (will substitute entrypoint or cmd with a call to /bin/bash) ** use only for testing purposes
  • -x = X11 mode (this enable the usage of tools that require an X11 server to run
  • -p = tcp connection port, not used anymore, but usually 22; obsolete
  • IMAGE_NAME = you image name composed by YOURUSERNAME/PROJECTNAME
  • CMD = optional command to exec (only real executable, not scripts, or you'll get errors)
  • PARAMETERS = optional parameters to your computation

Notes:

The interactive and X11 modes are usable either singularly or together:

Scenario Interactive (-i) X11 (-x)
Commands that runs in background NO NO
Testing commands interactively YES NO
Commands that needs X11 for computation NO YES (*)
Testing commands in X11 YES YES (**)

(*) use -X ssh option and occam-x11 to get the screen on your desktop/laptop (**) use -X ssh option to get the screen directly redirected to your desktop/laptop


3. occam-inspect

Description:

This command let you view an htop (http://hisham.hm/htop/) interactive process viewer for computations running on a node.

Usage:

occam-inspect [-n nodename]

where:

  • -n = computation node name

4. occam-kill

Description:

This command let you stop a computation running on a node.

Usage:

occam-kill [-n nodename] computation-ID

where:

  • -n = computation node name
  • computation-ID = the ID as shown by the occam-run command; in interactive mode, exiting from the shell, closes automatically that computation.

5. occam-x11

Description:

This command let you show the screen for computation running on a node in X11 mode detached. When executed this command will require an -X option in you ssh connection and the password for you remote X screen

Usage:

occam-x11[-n nodename]

where:

  • -n = computation node name

6. occam-nvidia-smi

Description:

This command let you view the nVidia GPU status (usable on GPU nodes only!!).

Usage:

occam-nvidia-smi [-n nodename]

where:

  • -n = GPU computation node name

7. occam-build

Description:

This command let you build and push to internal registry your docker images using the occam's nodes.

Usage:

occam-build [-n nodename] [--tag TAG] [ --build-arg BARGS ] [--force-rm ] [ --label LABEL] [--no-cache] [--pull] [--quiet] [ --rm]

where:

  • -n = node name
  • --tag = the image tag: before building, you should create a project on gitlab to store the resultant image
  • --build-arg = Set build-time variables
  • --force-rm = Always remove intermediate containers
  • --label = Set metadata for an image
  • --no-cache = Do not use cache when building the image
  • --pull = Always attempt to pull a newer version of the image
  • --quiet = Suppress the build output and print image ID on success
  • --rm = Remove intermediate containers after a successful build

8. occam-wait

Description:

This command let you synchronously wait for job termination

Usage:

occam-wait [job identifier]

where:

  • job identifier = is the job identifier as printed out by occam-run command (e.g. node22-123412)