Desktop Installation

This page describes the installation of Pumas on desktop systems (Windows and macOS). Two installation methods are available: using the Visual Studio Code extension (recommended) or manual installation via the command line.

Prerequisites

System Requirements

Ensure your system meets the following specifications:

Component	Minimum Requirement	Recommended
Operating System	Windows 10 or macOS 10.15	Latest Windows or macOS
RAM	8 GB	16 GB or more
CPU	4 Cores	8 Cores or more
Disk Space	10 GB	20 GB or more

Required Software

Visual Studio Code

Download and install VS Code from the official website: https://code.visualstudio.com/download

License Key

You must have a valid Pumas license key. This was provided via email when you purchased or received access to Pumas.

Installation Steps

Step 1: Install the Pumas Extension

Launch Visual Studio Code
Open the Extensions view (Ctrl+Shift+X on Windows, Cmd+Shift+X on macOS)
Search for "Pumas" in the marketplace
Click Install on the official Pumas extension published by PumasAI

Step 2: Install Required Extensions

After installing the Pumas extension, VS Code will check for required dependencies:

If the Julia and Quarto extensions are not installed, a notification will appear
Click Install to add both extensions automatically
VS Code will restart to activate the extensions

Step 3: Install juliaup

The extension uses juliaup to manage Julia versions:

After VS Code restarts, the extension checks for juliaup
If not found, a notification appears asking to install it
Click Install Automatically
When prompted in the terminal, type y and press Enter to confirm
Restart VS Code after installation completes

Step 4: Install Pumas

Run Pumas: List Versions from the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
Select the Pumas version you want to install
Choose the installation type:
- Global Installation: Available system-wide for all projects
- Project Installation: Specific to a single project folder
The installation runs in a terminal window (20-30 minutes)

After installation starts, a notification appears to configure VS Code:

Click Configure VS Code
Choose Set Globally for system-wide use or Set for Workspace for the current project

Using Pumas

Starting the REPL

Once configured, start Julia with Pumas:

Open the Command Palette
Run Julia: Start REPL
The REPL opens with the configured Pumas environment
Load Pumas with:
```
using Pumas
```
When loading Pumas for the first time, you will be prompted to enter your license key through a terminal menu.

Managing Versions

Viewing Installed Versions

Run Pumas: List Versions to see all available and installed versions. Installed versions show "- Installed" in the description.

Switching Versions

Select an installed version from the list
Choose Configure VS Code
Select global or workspace configuration

Removing Versions

Select an installed version
Choose Remove
Confirm the removal

This removes the juliaup channel and deletes the environment folder at ~/.julia/environments/{productId}.

Additional Commands

All commands are available through the Command Palette:

Pumas: Get Started - Opens the welcome page
Pumas: List Versions - Shows available versions
Pumas: Show Logs - Opens the output panel
Pumas: Clear Cache - Clears cached version information

Configuration

VS Code Settings

After installation, verify your configuration:

Open Command Palette
Run Preferences: Open User Settings (JSON)
Check that julia.executablePath points to the correct Pumas installation
Check that julia.environmentPath points to the correct environment
Remove any references to older Pumas versions

Project-Specific Installation

For project isolation:

Open your project folder in VS Code
Run Pumas: List Versions
Choose Install in project when installing
Select your project folder

Manual Installation Without VS Code

This section describes an alternative installation method for users who prefer command-line installation or cannot use the VS Code extension. The manual installation uses PumasProductManager.jl to manage Pumas versions.

Prerequisites

Install Julia via juliaup, which is the official Julia version manager. This is required for the product manager to work.

Installation Steps

Step 1: Install PumasProductManager

Start Julia with a separate environment for the product manager:

julia --project=@PumasProductManager

Install and load the product manager:

julia> import Pkg;
       Pkg.add(url = "https://github.com/PumasAI/PumasProductManager.jl");
       import PumasProductManager;

Step 2: List Available Products

Enter the package manager by pressing ] and list available products:

pkg> pumas list
DeepPumas@0.8.0
DeepPumas@0.8.1
Pumas@2.6.0
Pumas@2.6.1
Pumas@2.7.0

Step 3: Install a Product

Initialize the desired product version:

pkg> pumas init Pumas@2.7.0

This downloads and installs all required packages and precompiles them. The process takes 20-30 minutes.

For project-specific installation, specify a path:

pkg> pumas init Pumas@2.7.0 my-project

Step 4: Use the Installed Product

Exit Julia and restart with the newly installed version:

julia +Pumas@2.7.0

Or for a project-specific installation:

julia +Pumas@2.7.0 --project=my-project

Load Pumas:

julia> using Pumas

When loading Pumas for the first time, you will be prompted to enter your license key through a terminal menu.

Managing Products

Updating PumasProductManager

To check for new product versions:

$ julia +PumasProductManager

pkg> update

julia> exit()

$ julia +PumasProductManager

pkg> pumas list

Adding Packages to Environments

Add additional packages to a Pumas environment:

julia +Pumas@2.7.0

pkg> add --preserve=all ExtraPackage

The --preserve=all flag ensures compatibility with the fixed Pumas package versions.

Uninstalling Products

Remove the directory containing the Project.toml and Manifest.toml files. For global installations, these are typically in ~/.julia/environments/{product-name}.

To remove the product manager itself:

$ julia +PumasProductManager

pkg> status

This shows the environment path. Remove that directory to uninstall.

VS Code Configuration (Optional)

To use VS Code with a manually installed Pumas, follow the configuration steps in the Configuration section above, using paths like:

Executable Path: julia +Pumas@2.7.0
Environment Path: ~/.julia/environments/Pumas@2.7.0

For setting default juliaup channels:

# Global default
juliaup default Pumas@2.7.0

# Project-specific override
juliaup override set Pumas@2.7.0

Usage with Quarto

If you've set a default juliaup channel, Quarto notebooks require no special setup. Include engine: julia in the frontmatter.

For specific versions without a default channel:

---
engine: julia
julia:
  exeflags: ["+Pumas@2.7.0"]
---