Installation

Non-Windows Users

Visit the Pixi installation page and follow instructions to install Pixi in your shell.

Tutorial: Install Pixi with Powershell for Windows

1. Install Pixi

Visit the Pixi installation page and follow instructions to install Pixi in your shell.

2. Open Powershell and Configure Pixi

This code below tells Powershell to allow pixi to connect to the shell

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
pixi shell

Technical explanation

This sets the current user's PowerShell execution policy to "RemoteSigned," allowing local scripts to run unsigned while requiring signatures for downloaded scripts. - Local scripts run without needing a digital signature, allowing for flexibility during development. - Scripts from the internet must be signed, which helps protect against running untrusted or tampered code.

Command Breakdown

- `Set-ExecutionPolicy`: Changes the PowerShell script execution policy.
- `RemoteSigned`: Allows unsigned local scripts, but requires a signature for downloaded ones.
- `-Scope CurrentUser`: Affects only your user account (no admin rights needed).

3. Move to CoastSeg

Change directories to the location of your pyproject.toml

1. cd <CoastSeg folder containing pyproject.toml>

2. Check if the pyproject.toml exists in that directory with Test-Path .\pyproject.toml

   1. If it exists it will print True

4. Validate Pixi is Working

Activate the environment with:

pixi shell --frozen

1. This will activate the default environment, which in this example is called (coastseg)

If you get an error like:

Then try the following (you don’t need admin permissions)

• This command tells powershell that Pixi is safe to connect to Powershell, buts temporary so you will need to re-run it each time you run pixi shell in a new powershell window

function Invoke-Pixi {
    powershell.exe -ExecutionPolicy Bypass -Command "pixi $args"
}

Set-Alias pixi Invoke-Pixi -Option AllScope

pixi shell --frozen