#32: KaraboGui installation: Miniforge
======================================

In order to use Conda, three basic steps are needed:

#. Install Conda (`recommended conda installer <https://docs.desy.de/maxwell/documentation/licensing/conda_terms/>`_). We use **Miniforge**, here.
#. Configure channels.
#. Install the KaraboGUI.


Install Conda
-------------
Download and install **Miniforge** (Python version >= 3)

#. Download the installer script/executable.

   * Linux:
      Download and install by running

      .. code-block:: bash

         curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh"
         bash Miniforge3-$(uname)-$(uname -m).sh

   * Mac :
      Download `the script <https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-x86_64.sh>`_ and install by running

      .. code-block:: bash

         bash Miniforge3-MacOSX-x86_64.sh


   * Windows:
      Download `the installer
      <https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Windows-x86_64.exe>`_

      Double-click on ``Miniforge3-Windows-x86_64.exe`` to run the installer.



#. Follow the installation prompt. On Windows, remember to keep the "Create start menu shortcuts" option selected (by default, selected), in the final step.
#. Open your terminal (Miniforge3 PowerShell on Windows or Bash on Linux and MacOS)
#. If conda is in your path, you should be able to run

   .. code-block:: bash

      conda –-version

   If it is not, you need to activate conda first

      * Linux/MacOS:

         .. code-block:: bash

               source <miniforge_path>/etc/profile.d/conda.sh
      * Win:

         .. code-block:: bash

               CALL <miniforge_path_path>/condabin/activate.bat

By default *miniforge_path* is on your home directory - ``~/miniforge3`` on Linux/Mac and
on ``C:\Users\<YourUsername>\miniforge3`` (or ``C:\Users\<YourUsername>\AppData\Local\miniforge3``) on Windows.


Channel Configuration
---------------------


If you have already installed karabogui on your machine using conda before, you could skip to the next step, as you may have already configured your channels correctly.
Please ensure to remove the **defaults** channels.

   .. code-block:: bash

      conda config --remove channels defaults


Also ensure that karabo channels are added.

   .. code-block:: bash

      conda config --add channels http://exflctrl01.desy.de/karabo/channel
      conda config --add channels http://exflctrl01.desy.de/karabo/channel/mirror/conda-forge


You can verify that the channels are added correctly, by running

   .. code-block:: bash

      conda config --show channels

and you will get

   .. code-block:: bash

      channels:
         - http://exflctrl01.desy.de/karabo/channel/mirror/conda-forge
         - http://exflctrl01.desy.de/karabo/channel
         - conda-forge


For more details for Karabo channels, refer to `karabo documentation <https://rtd.xfel.eu/docs/karabo/en/latest/installation/gui.html#remote-installations-using-ssh-tunneling>`_


Install KaraboGUI
-----------------

To install the latest karabogui (recommended)

.. code-block:: bash

   conda create -n karabogui_latest karabogui --yes


or install a specific version

.. code-block:: bash

   conda create -n karabogui<version> karabogui=<version> --yes

For example:

.. code-block:: bash

   conda create -n karabogui_2_20_7 karabogui=2.20.7 --yes