Revision as of 12:15, 27 March 2024

Table of contents

Welcome! Have you ever wanted to edit code for GlueX analysis using smart code completion, debuggers, integrated Git, syntax highlighting, and so much more, all wrapped into one? Well look no further than Visual Studio (VS) Code! By the end of this guide, you will be able to connect to the ifarm and have all these powerful tools right at your fingertips. This includes the Extensions marketplace, which adds incredibly powerful features and tools to your programming setup. If you run into any problems then please message me, Kevin Scheuer, over Slack (or email) and let me know!

Windows Users: This guide is primarily aimed at macOS / Linux users, but there will be slight deviations for windows machines. Look for blue text that will denote Windows-specific instructions.

Setup

Before beginning, please ensure you have the following:

• A working JLab Computing account
• A 2 Factor Authentication Method (2FA) setup. This is MobilePASS or Google Authenticator.
  • See the guide under Software on the Getting Started at GlueX page
  • Or see the Prerequisites section in this servicenow article
• Downloaded VS Code for your OS

The .ssh/config file

1. Your first step for getting onto the ifarm will be creating an ssh config file, which dictates how your device, or “local machine”, will connect to the remote JLab server
2. Open VS Code and navigate to the Extensions tab on the left-hand sidebar. Copy and paste ms-vscode-remote.remote-ssh into the search bar, and install the package.
   1. If you can’t see the sidebar, try in the menu View > Appearance > Primary Side Bar
3. In the menu bar go to View > Command Palette. Search and select Remote-SSH: Open SSH Configuration File
4. Your default file is likely at /Users/YOUR_USERNAME/.ssh/config. Select this file and it should now open in the editor view.
   1. If the file is not yet created, no worries. Open VS Code's integrated terminal with Terminal > New Terminal or View > Terminal and navigate to the .ssh folder. Run touch config to create a blank file. Now open the file as instructed.
   2. Windows Users: Your file path should be C:/Users/YOUR_USERNAME/.ssh/config
5. If settings already exist in this file they can be kept, so long as they are not ifarm related. We will be using a slightly modified version from the JLab recommended config file. Download the OS specific custom config file and copy/paste its contents into the .ssh/config file open in the VS Code editor
6. At the very bottom edit User YOUR_USERNAME_HERE and replace with your JLab CUE username
7. Notice there is now a dot next to the file name. This indicates edits have been made and need to be saved. Save the changes with File > Save and close the file by pressing the X next to the file name
8. Open the command palette again and search/select Preferences: Open User Settings
9. Search Remote.SSH: Remote Server Listen on Socket and ensure this option is selected.
10. While we’re here, let's also change the default .vscode-server location. This dictates where your Extensions and some other modules will be stored, but can quickly outgrow the limits of its default location on the ifarm at /home/YOUR_USERNAME/. It's highly recommended to put this in a more spacious location like a user’s directory on the work disk. Search Remote.SSH: Server Install Path in your user settings, and set key to ifarm and Value to be your directory of choice
    1. For example, mine is /w/halld-scshelf2101/kscheuer/
11. Lastly, ssh needs a specific directory to be setup to work properly. Open a terminal and navigate to /Users/YOUR_USERNAME/.ssh/ (or wherever your config file is) and perform mkdir cm

Connecting

1. Before we go about connecting with VS Code, let's test the config file and ensure the connection can be established. Open a terminal via Terminal > New Terminal or View > Terminal and simply run ssh ifarm. Note that even though the terminal is "integrated" as part of VS Code, for the most part, it functions just like any terminal window
2. You should be prompted to enter a password, which will be your 2FA method (MobilePASS or Google Authenticator). Click enter and another prompt will appear. This time enter your JLab CUE password.
3. You should be taken to your home directory on an ifarm node. We now know the connection can be made. Type exit and click enter to close the session
   1. If you get to the JLab CUE prompt and enter your password but the connection is hanging, it may be that the ifarm node it's routing you to is having issues. There are 3 nodes 1801, 1802, and 1901. Retry from step 1 but do ssh ifarmXXXX replacing the X’s with one of the three node numbers
4. From the Command Palette run Remote-SSH: Connect to Host. Select the option ifarm
   1. If you’d prefer a new window to not be opened, execute Remote-SHH: Connect Current Window to Host
5. It may ask what type of system this is, select Linux. Similar to the connection we did in the terminal, you will be prompted for 2 consecutive passcode inputs. The first will be the 2FA method, and the second your CUE password
   1. A popup may appear saying "The remote host may not meet VS Code Server's prerequisites for glibc and libstdc++". Essentially, support for the ifarm's current operating system will drop by January 2025, but we will be updated by then so there's no need to worry about this. A banner might also appear stating "You are connected to an OS version that is unsupported by Visual Studio Code". This too can be ignored.
6. VS Code will configure the connection, and if successful there should be a green status bar in the lower left corner. You can even open a terminal and see what node you are on, and verify that you are in your home directory
7. Congratulations, you are now connected and ready to code! You can exit at any time by clicking on that green status bar and selecting Close Remote Connection.

Using ssh keys

This section is completely optional, and yet to be fully tested, but if working correctly it means you'll never have to enter your CUE password again! In short, we'll make 2 ssh keys: one that sits on our local machine, and the "public" key that we'll place on the ifarm. There are different algorithms and key sizes you can use, here we'll be using RSA.

1. In a terminal, run ssh keygen -t rsa
2. It will ask where you want to place the file. Place it in the same destination as the config file
3. It then asks for an optional passphrase for the keys. To leave it empty, just press enter
   1. Note: using a non-empty passphrase has yet to be tested
4. Now we can copy the public key to the ifarm. Run ssh-copy-id -i ~/.ssh/YOUR_KEY_NAME.pub -o ProxyJump=USER@scilogin.jlab.org USER@ifarm replacing YOUR_KEY_NAME with the key name with what was generated, and USER with your JLab username
5. Enter the requested passwords. Both terminal and VS Code should recognize these keys and no longer require a CUE password to be entered!

Troubleshooting

• I was able to connect before, but now it's failing and/or repeatedly asks for the password prompt
  • In the command palette perform “Remote SSH: Kill VS Code Server on Host” and select ifarm. Doing this once should reset the connection
    • This shouldn't remove your extensions, but if you want to be safe you can make a backup of your .vscode-server on the ifarm

Working With VS Code

A full tutorial on how to use VS Code is beyond the extent (and reasonable length) of this guide, but the official getting started webpage for VS Code is highly recommended.

Extensions

A lot of the power of VS Code comes from its “Extensions”. Below are listed some necessary ones that allow VS Code to interact with C++ or Python nicely, but also some incredibly useful ones and highlights of their features. You can search for each extension by name, or copy-paste its ID into the search bar. Note that extensions are stored in the .vscode-server on the ifarm, and in .vscode on your local machine, and so you can have different extensions for each location.

Standards

• C/C++ Extension Pack ms-vscode.cpptools-extension-pack
• Python ms-python.python
• Pylance ms-python.vscode-pylance
• Python Debugger ms-python.debugpy
• Jupyter ms-toolsai.jupyter

Recommended

• Docs View bierner.docs-view
  • Adds a tab in the explorer sidebar to view documentation of any function you select in the editor
  • Works for any object, not just the standard packages! This means while editing you can select your favorite AmpTools class/function and see its documentation on the fly
• ROOT File Viewer albertopdrf.root-file-viewer
  • Like a TBrowser, but all within VSCode!
• GitLens eamodio.gitlens
  • View the history and author of any line in a file (that’s in a GitHub repo of course)
  • See a graph of all the commit history
• Git Graph mhutchie.git-graph
  • Free alternative to graph feature of GitLens if you have private repos
• Emacs keymapping hiro-sun.vscode-emacs
  • Note that it doesn’t always work perfectly, I think it tries not to override any VS Code keymaps, but this can be configured
  • Oh, and if for some reason you like vim… vscodevim.vim
• CSV to Table phplasma.csv-to-table
  • This extension gives you a command-palette option Convert to Table from CSV that gives you a very nice table-style view of any CSV file
• Edit csv janisdd.vscode-edit-csv
  • Lets you edit CSV files with a table UI similar to Excel
• Rainbow CSV mechatroner.rainbow-csv
  • Makes viewing and editing CSV files easier by coloring columns
• Code Spell Checker streetsidesoftware.code-spell-checker
  • Helps you to cut down the typos in variable names and comments
• Pylint ms-python.pylint
  • Helps you to keep your Python code straight
• Python Indent kevinrose.vsc-python-indent
  • Improves indentation of Python code
• Python Type Hint njqdev.vscode-python-typehint
  • Great if you use type hints (you should)
• Diff tabs jozefchmelar.compare
  • See diff of two tabs, even if they're not saved
• Partial Diff ryu1kn.partial-diff
  • Diff text selections within a file, across files, or to the clipboard
• indent-rainbow oderwat.indent-rainbow
  • Makes indentations easier to read
• Path Intellisense christian-kohler.path-intellisense
  • Autocompletes file paths
• Todo Tree gruntfuggly.todo-tree
  • Helps you to keep track of your TODOs and FIXMEs
• Trailing Spaces shardulm94.trailing-spaces
  • If you worry about whitespace errors
• Better PageUp/PageDown russelldavis.better-pageup-pagedown
  • If you do not like the default way scrolling with PageUp/Down works, give this a try
• VSCode is also a great platform for writing LaTeX documents
  • LaTeX Workshop james-yu.latex-workshop
    • Provides preview, compile, autocomplete, syntax highlighting, sync, and more
  • LTeX – LanguageTool grammar/spell checking valentjn.vscode-ltex
    • Grammar/spell checker using LanguageTool with support for LaTeX, Markdown, and others