From 7999a17c5bf1689281ec3429550b8cc80b29d09f Mon Sep 17 00:00:00 2001 From: Lars Bilke Date: Tue, 19 Sep 2023 14:12:45 +0200 Subject: [PATCH] [web] pip install instructions windows. --- .../userguide/basics/introduction/index.md | 34 +++++++++++++++++-- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/web/content/docs/userguide/basics/introduction/index.md b/web/content/docs/userguide/basics/introduction/index.md index 5290297d642..236603cea6a 100644 --- a/web/content/docs/userguide/basics/introduction/index.md +++ b/web/content/docs/userguide/basics/introduction/index.md @@ -46,15 +46,43 @@ On macOS you can use either a virtual machine (e.g. via [UTM](https://docs.getut A straightforward way of installing OGS is via Python's [`pip`-tool](https://packaging.python.org/en/latest/tutorials/installing-packages/): +
+ +```powershell +# Optional: create a Python virtual environment, see below +python -m venv .venv +.\venv\Scripts\Activate.ps1 + +# Install ogs' pip package +pip install ogs +``` + +If you get errors when calling the `Activate.ps1` script you have to run the following command once: + +```powershell +Set-Execution-Policy Unrestricted -Scope CurrentUser +``` + +
+ +
+ ```bash # Optional: create a Python virtual environment, see below python -m venv .venv # or `python3 -m venv .venv` -source .venv/bin/activate # Linux / macOS; for Windows: .\venv\Scripts\activate +source .venv/bin/activate # Install ogs' pip package pip install ogs + ``` +
+ +
+See Linux-tab! +
+ Please note that this requires a Python installation (version 3.8 - 3.11) with the `pip`-tool. We recommend using Python within a [virtual environment](https://docs.python.org/3/library/venv.html) to keep possible @@ -89,8 +117,8 @@ to just download the latest stable or development release of OpenGeoSys from the By downloading from the release page you will get a bunch of folders and files. However, OGS itself will come as a simple executable file, which you will find in the `bin` sub-folder. You can put the executable wherever you like. For convenience you -may put it into a location which is in your `PATH`-environment variable which allows you to start the executable without -specifying its full file path just calling `ogs` from the terminal of your machine. +may put it into a location which is in your `PATH`-environment variable or [modify](https://stackoverflow.com/a/714918/80480) the `PATH` environment variable which allows you to start the executable without +specifying its full file path. Then just calling `ogs` from the terminal is sufficient.