From 8456e5a70d1d653ca02e8501925a3fde15c7b78b Mon Sep 17 00:00:00 2001 From: Aashvi Pandey Date: Sat, 7 Feb 2026 10:44:28 +0530 Subject: [PATCH 1/2] docs: clarify venv usage and add post-installation verification --- docs/source/installation.rst | 60 ++++++++++++++++++++++++++++++++---- 1 file changed, 54 insertions(+), 6 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 0752835c..5490abbf 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -2,43 +2,91 @@ Installation ============ +Requirements : +Virtual Environment(venv): A virtual environment is an isolated directory on a computer that contains a specific Python installation, along with its own libraries, scripts, and dependencies. It acts as a sandbox, allowing developers to manage project-specificdependencies without conflicting with global system packages or other projects. + +1.A virtual environment is required in Python to isolate project dependencies, preventing version conflicts between libraries. + +2. It creates an independent directory containing its own Python executable and packages, allowing different projects to use different versions of the same library. It is essential for maintaining clean, reproducible development environments. + Steps: 1. Clone the repository: -.. code-block:: shell +.. code-block:: shell/terminal git clone https://github.com/52North/WeatherRoutingTool.git 2. Change to the folder: -.. code-block:: shell +.. code-block:: shell/terminal cd WeatherRoutingTool 3. [recommended] Create and activate a virtual environment, e.g. -.. code-block:: shell +.. code-block:: shell/terminal + + python3 -m venv "venv"/py -m venv "venv" + + for mac: - python3 -m venv "venv" source venv/bin/activate + for windows: + + .\venv\Scripts\Activate.ps1 + 4. Install the WRT: 4.1. In normal mode - .. code-block:: shell + .. code-block:: shell/terminal pip install . && pip install --no-deps -r requirements-without-deps.txt 4.2. In editable mode (recommended for development) - .. code-block:: shell + .. code-block:: shell/terminal pip install -e . && pip install --no-deps -r requirements-without-deps.txt The part ``pip install --no-deps -r requirements-without-deps.txt`` is necessary because of a dependency issue (see `issue 8 `_). We might implement a different solution in the future making the installation easier/cleaner. + + WHAT TO DO AFTER INSTALLATION ? + +After you have successfully installed the tool, the next step is to run a test simulation to see it in action. +The tool needs specific weather data (GRIB files) and boat polar files to work, the absolute best way to start is by using the Sandbox. + +Steps: + +1.Get the Sample Data (The Sandbox): + + Clone the sandbox : + + .. code-block:: In integrated terminal + cd .. + + git clone https://github.com/52North/WRT-sandbox.git + +2. Change to the folder: + +.. code-block:: shell/terminal + + cd WeatherRoutingTool + +**Configure the tool** + Open "Configuration/config.template.json" and ensure the paths are correct for your Operating System + +3.Run Your first "Weather Route"(make sure (venv )is still active) + Set your ``PYTHONPATH`` to the root of the ``WeatherRoutingTool`` directory and execute the run script: + +.. code-block:: shell/terminal + + $env:PYTHONPATH = "path/to/WeatherRoutingTool" + python run_WRT.py + **Power/fuel consumption framework** From bd31dd37a4b3ecc8a86f03ff5dd95831bf2c0e46 Mon Sep 17 00:00:00 2001 From: Aashvi Pandey Date: Sat, 7 Feb 2026 11:12:46 +0530 Subject: [PATCH 2/2] docs: clarify venv usage and add post-installation verification --- docs/source/installation.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index 5490abbf..80c16b0b 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -5,7 +5,7 @@ Installation Requirements : Virtual Environment(venv): A virtual environment is an isolated directory on a computer that contains a specific Python installation, along with its own libraries, scripts, and dependencies. It acts as a sandbox, allowing developers to manage project-specificdependencies without conflicting with global system packages or other projects. -1.A virtual environment is required in Python to isolate project dependencies, preventing version conflicts between libraries. +1. A virtual environment is required in Python to isolate project dependencies, preventing version conflicts between libraries. 2. It creates an independent directory containing its own Python executable and packages, allowing different projects to use different versions of the same library. It is essential for maintaining clean, reproducible development environments. @@ -61,7 +61,7 @@ The tool needs specific weather data (GRIB files) and boat polar files to work, Steps: -1.Get the Sample Data (The Sandbox): +1. Get the Sample Data (The Sandbox): Clone the sandbox : @@ -79,7 +79,7 @@ Steps: **Configure the tool** Open "Configuration/config.template.json" and ensure the paths are correct for your Operating System -3.Run Your first "Weather Route"(make sure (venv )is still active) +3. Run Your first "Weather Route"(make sure (venv )is still active) Set your ``PYTHONPATH`` to the root of the ``WeatherRoutingTool`` directory and execute the run script: .. code-block:: shell/terminal