{
 "cells": [
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# iBridges GUI\n",
    "\n",
    "This notebook shows how to download files and directories from the **UNLOCK FAIR Data Platform** using iBridges. It focuses on demonstrating usage of the Graphical User Interface (GUI).\n",
    "\n",
    "iBridges GUI documentation:\\\n",
    "<https://ibridges-for-irods.github.io/iBridges-GUI>\n",
    "\n",
    "GitHub repository:\\\n",
    "<https://github.com/iBridges-for-iRODS/iBridges-GUI>\n",
    "\n",
    "The iBridges Graphical User Interface is the most user-friendly and intuitive way to interact with your UNLOCK FDP storage in a fairly powerful manner. It is available for most operating systems (Windows, Mac, and Linux).\n",
    "\n",
    "## Installation\n",
    "To install the iBridges GUI, you can download a binary file from:\n",
    "> (**NOTE**, this still an experimental feature, and not generally recommended)  \n",
    "<https://github.com/iBridges-for-iRODS/iBridges-GUI/releases>  \n",
    "\n",
    "Alternatively, install the GUI through pip:\n",
    "\n",
    "Make sure Python version 3.8+ is installed. If you are unfamiliar with Python, install [Anaconda](https://www.anaconda.com/download/success).\n",
    "\n",
    "You can then install iBridges using pip in a terminal:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%pip install ibridges"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Then, install the iBridges GUI:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%pip install ibridgesgui"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Now, run the iBridges GUI from the command line using the command `ibridges-gui`."
   ]
  },
  {
   "attachments": {},
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Authentication\n",
    "\n",
    "iBridges (like all iRODS clients) requires a configuration file, which ensures that your connection is encrypted and that you do not need to provide all access information each time you connect to the UNLOCK FDP. This file is typically stored in your home directory under a folder called `.irods`:\n",
    "\n",
    "| OS       | Path to `.irods` folder                  |\n",
    "|----------|------------------------------------------|\n",
    "| Windows  | `C:\\Users\\<your-username>\\.irods`        |\n",
    "| macOS    | `/Users/<your-username>/.irods`          |\n",
    "| Linux    | `/home/<your-username>/.irods`           |\n",
    "\n",
    "To create the configuration file, click on `Configure`, and then `Add configuration`. In the drop-down menu you can find existing iRODS configuration files, which can be checked and edited in this window.\n",
    "Click `New Config` and edit the fields accordingly:\n",
    "- \"irods_authentication_scheme\": \"pam_password\"\n",
    "- \"irods_default_resource\": \"hot_1\"\n",
    "- \"irods_home\": \"/\"\n",
    "- \"irods_host\": \"data.m-unlock.nl\"\n",
    "- \"irods_user_name\": \"<FILL_IN_YOUR_SRAM_USERNAME_HERE>\",\n",
    "- \"irods_zone_name\": \"unlock\"\n",
    "\n",
    "Use the `Check` button to validate your configuration file. If your configuration file is not correct the program will guide you to add the required fields. Once all checks have passed, save your environment file."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Connection\n",
    "Click `Connect`, then `Connect to iRODS` and fill in your SRAM token.\n",
    "\n",
    "The iBridges GUI supports three main functionalities:\n",
    "- browse through storage collections\n",
    "- upload, download, or synchronize data\n",
    "- manipulate metadata and permissions\n",
    "\n",
    "![iBridges gui](./images/ibridges_gui.png)\n",
    "\n",
    "Apart from the `Browser` tab for permission, data and metadata manipulation, there is a dual-pane `Synchronise Data` tab, as well as a `Search`, `Info`, and `Logs` tab. When searching data, (a selection of) results can be downloaded. The usage of the iBridges GUI should be relatively straightforward, but if anything remains unclear, refer to the user documentation:  \n",
    "<https://ibridges-for-irods.github.io/iBridges-GUI/docs/userdoc.html>"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Testing_nbs",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.12.8"
  },
  "orig_nbformat": 4
 },
 "nbformat": 4,
 "nbformat_minor": 2
}