Pumas VS Code Extension

This extension helps you manage and use different versions of Pumas and DeepPumas within VS Code.

What This Extension Does

The extension allows you to:

• Install and manage multiple versions of Pumas and DeepPumas
• Switch between different versions for different projects
• Open a Julia REPL with a specific Pumas version loaded
• Configure VS Code's Julia extension to work with your selected Pumas version

Requirements

• Julia installed on your system
• juliaup for managing Julia versions (the extension will help you install this if needed)
• VS Code version 1.102.0 or higher

Getting Started

1. After installing the extension, use the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on Mac)
2. Run Pumas: Get Started to see the welcome page with documentation links
3. Run Pumas: List Versions to see available Pumas and DeepPumas versions
4. Select a version to install or open in the REPL

How to Install Pumas Versions

When you run Pumas: List Versions, you'll see a list of all available versions:

• Stable releases are marked with a package icon (📦)
• Prereleases are marked with a flask icon (🧪)
• Installed versions show "- Installed" in the description

To install a version:

1. Select the version you want from the list
2. A menu appears with available actions:
   • If not installed: Choose "Install"
   • If already installed: Choose "Open REPL" or "Configure VS Code"
3. For installation, choose between:
   • Global installation: Makes the version available system-wide
   • Project installation: Installs in a specific project folder

The installation runs in the terminal so you can see the progress.

How to Use Installed Versions

Once you have a version installed:

1. Run Pumas: List Versions
2. Select your installed version (shows "- Installed" in description)
3. Choose from the menu:
   • Open REPL: Starts Julia with that specific Pumas version loaded
   • Configure VS Code: Sets this version as your default for all Julia operations
   • Remove: Uninstalls the product (removes juliaup channel and environment folder)

Setting a Default Pumas Version

You can configure VS Code to always use a specific Pumas version:

1. Click on an installed version in the list
2. Select "Configure VS Code"
3. Choose between:
   • Set Globally: Makes this the default for all VS Code windows
   • Set for Workspace: Only applies to the current project/workspace

Once configured, the Julia extension's "Start REPL" command will automatically use your selected Pumas version. This is the recommended way to work with a consistent Pumas version across your projects

Removing a Pumas Version

To uninstall a Pumas product:

1. Select an installed version from the list
2. Choose "Remove" from the menu
3. Confirm the removal when prompted

This will:

• Remove the juliaup channel (for global installations)
• Delete the environment folder at ~/.julia/environments/{productId}

Note: Removal cannot be undone. You'll need to reinstall the product if you want to use it again.

Available Commands

All commands are available through the Command Palette (Ctrl+Shift+P or Cmd+Shift+P):

• Pumas: Get Started - Opens the welcome page with links to documentation
• Pumas: List Versions - Shows all available Pumas and DeepPumas versions with install/open options
• Pumas: Show Logs - Opens the output panel to see installation progress and diagnostic messages

Settings

The extension provides these settings (accessible in VS Code settings):

• pumas.showWelcomeOnStartup: Whether to show the welcome page when VS Code starts (default: true)

Working with Projects

You can install different Pumas versions for different projects:

1. Open your project folder in VS Code
2. Run Pumas: List Versions
3. Click "Install" and choose "Install in project"
4. Select your project folder

This keeps your project isolated with its own Pumas version.

Background Operations

The extension handles several things automatically:

• Installs PumasProductManager.jl (the Julia package that manages Pumas versions) when first needed
• Checks for and offers to install juliaup if it's not found
• Suggests installing the Julia and Quarto VS Code extensions for the best experience
• Caches version information for faster access

Troubleshooting

If you encounter issues:

No versions appearing: The extension may be setting up in the background. Wait a few seconds and try again.

Installation fails: Run Pumas: Show Logs to see detailed error messages.

Julia not found: Make sure Julia is installed and available in your system PATH.

Juliaup not found: The extension will prompt you to install it. Follow the provided instructions.

REPL doesn't start: Check that the Julia extension is installed and configured correctly.

Technical Details

The extension works by:

• Using juliaup to manage different Julia channels for each Pumas version
• Installing Pumas products through PumasProductManager.jl
• Configuring the VS Code Julia extension to use the correct executable and environment
• Managing terminals and REPLs for running Julia with specific Pumas versions

Resources

• Pumas Documentation
• Pumas Tutorials
• Julia Documentation
• VS Code Julia Extension

License

This extension is proprietary software. Please refer to your Pumas license agreement for details.