Skip to content

Update installation guide#1065

Merged
nkrah merged 4 commits into
masterfrom
docs-improve-developer-installation
Jun 18, 2026
Merged

Update installation guide#1065
nkrah merged 4 commits into
masterfrom
docs-improve-developer-installation

Conversation

@nkrah

@nkrah nkrah commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

Update the installation instructions, especially regarding virtual environments and Python interpreter version.

environment prior to the installation.

Example: You can create a new virtual environment via:
We recommend the Python package and project manager `uv <https://docs.astral.sh/uv/>`_ for creating GATE environments because it makes it easy to manage Python versions. Installation instructions are available in the official `uv installation guide <https://docs.astral.sh/uv/getting-started/installation/>`_.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand Thomas point on this. But if you change it, from my distant point of view (I still use miniconda :-)), pixi seems to have more momentum than uv nowadays.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I use plain venv plus awareness of the python interpreter I am relying on. But indeed issues about interpreter mismatches repeatedly pop up.

Good to know about pixi. Maybe we should rephrase in a more general way and recommend a manager that allows for explicit interpreter selection, like uv and pixi.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the dev and user guide and keep the recommendation on uv and pixi a bit more generic.

@nkrah nkrah force-pushed the docs-improve-developer-installation branch from e671c67 to 2861a5a Compare June 18, 2026 08:43
Comment thread README.md Outdated

```
python -m venv opengate_env
uv venv opengate_env

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you left uv intentionally here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, overlooked it

@SimonRit SimonRit left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@nkrah nkrah merged commit 25875eb into master Jun 18, 2026
2 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants