Authentication¶

VIPR repositories are hosted on codebase.helmholtz.cloud/vipr. The public repositories do not require authentication:

Package	Availability
`vipr-core`	Public — Helmholtz Codebase GitLab
`vipr-framework`	Public — Helmholtz Codebase GitLab
`vipr-frontend`	Public — Helmholtz Codebase GitLab
`vipr-reflectometry-plugin`	Public — Helmholtz Codebase GitLab
`vipr-helm-chart`	Public — Helmholtz Codebase GitLab
`vipr-gid-plugin`	Private — Helmholtz Codebase GitLab

Authentication is only required for private resources such as vipr-gid-plugin (and, where relevant, private container registry access).

vipr-gid-plugin (private)¶

The vipr-gid-plugin is hosted on codebase.helmholtz.cloud and is not publicly accessible. Access requires a Personal Access Token from the HZDR GitLab instance.

Create a Personal Access Token¶

Visit User Settings → Personal Access Tokens
Create a new token with at minimum the read_repository scope
Copy and store the token value immediately — it will not be shown again

Install with pip¶

pip install git+https://@your.username:glpat-xxxx@codebase.helmholtz.cloud/vipr/vipr-gid-plugin.git

Or when prompted interactively:

pip install git+https://codebase.helmholtz.cloud/vipr/vipr-gid-plugin.git
Username: @your.username
Password: glpat-xxxxxxxxxxxxxxxxxxxx

Security note: Treat the token like a password. Never commit it to version control or share it publicly.