From 7027c1c3049627fbc1665b81d8641980d43d1ae5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20Hin=C3=BCber?= <105521415+larshinueber@users.noreply.github.com> Date: Wed, 12 Feb 2025 15:41:08 +0100 Subject: [PATCH] add explicit steps to conda installation, note about wsl feature activation --- .../windows_subsystem_for_linux.rst | 47 +++++++++++++++++-- 1 file changed, 43 insertions(+), 4 deletions(-) diff --git a/docs/source/_src_getting_started/_src_use_of_tools/windows_subsystem_for_linux.rst b/docs/source/_src_getting_started/_src_use_of_tools/windows_subsystem_for_linux.rst index 5c331333..fd7e8dd6 100644 --- a/docs/source/_src_getting_started/_src_use_of_tools/windows_subsystem_for_linux.rst +++ b/docs/source/_src_getting_started/_src_use_of_tools/windows_subsystem_for_linux.rst @@ -19,9 +19,17 @@ In the context of Tudat(Py), having a Linux environment is required as of v0.9, Installing WSL ############## +.. important:: + Before you start, make sure that the Windows Subsystem for Linux (WSL) feature is enabled on your Windows machine. + + To check this, open the Control Panel -> Programs -> Programs and Features -> "Turn Windows features on or off" and make sure that the Windows Subsystem for Linux feature is enabled. + - Follow the installation guide on the `Microsoft website `_ to install WSL. - By default, this will install Ubuntu as a Linux distribution. This is a common choice and recommended for beginners as you will find plenty of support, but you can also `install other distributions `_. +.. note:: + If you run into any issues during the installation, you can find help in the `WSL troubleshooting guide `_. + Setting up WSL ############## In the following steps, we will assume that you have installed Ubuntu as your Linux distribution. @@ -88,13 +96,44 @@ Install Conda Tudat(Py) uses Conda to manage its dependencies. If you have used Conda before in your Windows environment, you will still have to install it in your WSL environment. As we will mainly use the command-line in WSL, Miniconda is recommended. -Follow the `installation instructions `_ and make sure conda is installed in your WSL environment: +The instructions in the following are based on the `official Anaconda documentation `_. -.. code-block:: bash +1. Open the terminal in WSL and download the latest Miniconda installer by running: + + .. code-block:: bash + + wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh + +2. Install Miniconda by running the following command in the same directory: + + .. code-block:: bash + + bash Miniconda3-latest-Linux-x86_64.sh + +3. Read through the Terms of Service and accept them. + +4. In the next step, it is recommended to install Miniconda in the default location. + +5. In the final step, you can configure the initialization of conda. + It is recommended to add conda to your PATH, but not activate the base environment automatically upon opening a new terminal, to avoid accidentally installing packages in the base environment. + + You can configure this by typing ``yes`` when prompted for the initialization option. + Then, restart your terminal and run the following command: + + .. code-block:: bash + + conda config --set auto_activate_base false + + Next time you open a terminal, the ``base`` environment will not be activated. + You can activate any environment by running ``conda activate ``. + +6. Lastly, make sure that conda is installed correctly by running: + + .. code-block:: bash - conda --version + conda --version -This should return the installed Conda version. + This should return the installed Conda version. From there on, you can follow the instructions in the :ref:`Conda primer ` to set up your Conda environment and :ref:`install Tudat(Py) `. .. dropdown:: Quick TudatPy installation