{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "31cdd027-e7ba-49dc-925c-05adbfe4f2a6",
   "metadata": {},
   "source": [
    "# Algorithm Registration UI\n",
    "The algorithm registration UI allows users to register algorithms stored in their public code repositories to the MAAP so the algorithms can then be used to run jobs on the MAAP."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "af04f513-8e0d-4825-9743-3f4be61a60cf",
   "metadata": {},
   "source": [
    "## Access\n",
    "1. Open your workspace\n",
    "2. Click the __Register Algorithm__ button from the launcher menu.\n",
    "\n",
    "![](../_static/algo_reg/algo_reg_access.png)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "db6cf90e-b313-4dc1-beba-088c4a8fc801",
   "metadata": {},
   "source": [
    "## Register an Algorithm\n",
    "1. Open the __Register Algorithm__ UI.\n",
    "2. Fill out the fields describing general information about the algorithm. This includes things like the repository the algorithm is stored in, the repository branch or tag (also referred to as the version of the algorithm), the command to execute the algorithm, etc.\n",
    "\n",
    "![](../_static/algo_reg/algo_reg_reg_general.png)\n",
    "\n",
    "#### Container URLs\n",
    "The Container URL is a dropdown where the default is a standard minimal container called `maap_base` image such as `mas.maap-project.org/root/maap-workspaces/custom_images/maap_base:v4.2.0`. The other option is the Container of your current workspace (i.e. R, pangeo, etc.). These containers will have numerous conda packages installed which may or may not be useful for you. Just a note if you want the default conda packages for your current workspace container, if you successfully ran the Algorithm in a Terminal without adding additional packages, then you should be able to successfully use your current workspace container as the **Container URL** for your algorithm. \n",
    "We recommend using `maap_base` as it makes algorithm registration faster, although using it means you need to manage your own conda packages. More information how to make a custom conda environment [here](custom-environments.html#Custom-environments).\n",
    "\n",
    "To find another Container URL, go to:\n",
    "https://repo.maap-project.org/root/maap-workspaces/container_registry (choose `Packages and Registries > Container registry` if you go to the main maap-workspaces area). Find your base Stack and dig in until you can copy the link of the specific version of Stack that you need, as demonstrated in these screenshots:\n",
    "![Container registry](../getting_started/_static/registry-1-containers.png)\n",
    "![Container vanilla](../getting_started/_static/registry-2-vanilla.png)\n",
    "![Container copy link](../getting_started/_static/registry-3-copy-link.png)\n",
    "This custom Container URL can be used if you register your algorithm from a yaml file instead of our algorithms UI. You can generate a sample yaml file by registering the algorithm with all your other arguments, then in the resulting generated yaml file in the `algorithm-configs` folder, you can manually change the Container URL. \n",
    "\n",
    "3. Fill out the algorithm inputs. To add a new input, click the green plus circle. To remove an input click the red x circle.\n",
    "\n",
    "![](../_static/algo_reg/algo_reg_reg_inputs.png)\n",
    "\n",
    "4. Once all information is filled out, click the __Register Algorithm__ button at the bottom of the form. After a few seconds, a modal will appear with the link to the registration job that was just submitted. Users can navigate to this link to access the registration logs and confirm their algorithm was registered successfully.\n",
    "\n",
    "![](../_static/algo_reg/algo_reg_reg_ci.png)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "1f838e93-a191-4a72-84cf-e22c31c7ec9d",
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3.13.0 64-bit",
   "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.13.0"
  },
  "vscode": {
   "interpreter": {
    "hash": "b0fa6594d8f4cbf19f97940f81e996739fb7646882a419484c72d19e05852a7e"
   }
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}