{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "5322d05d-7d0e-4ff6-899d-40cead92b68f",
   "metadata": {},
   "source": [
    "# Check your installation"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "373494bd-274f-4c33-bc53-df81dbf77a14",
   "metadata": {},
   "source": [
    "```{hint}\n",
    "In all the forecoming pages, `!` is used to run shell commands and `%` is used for IPython magic commands. Don't let this distract you 🙂. It is something specific to IPython and Jupyter, but in practice the behaviour of these commands are identical to running simple shell commands in your terminal.\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "2c6cd108-ac4f-4148-b924-e247e1123a41",
   "metadata": {},
   "source": [
    "Have you have managed to [install the package](install)? If so you should at least be able to do this:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "e1689af5-a43c-4774-af45-c038bc328b5d",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\u001b[1m                                                                                \u001b[0m\n",
      "\u001b[1m \u001b[0m\u001b[1;33mUsage: \u001b[0m\u001b[1mdawsonia [OPTIONS] COMMAND [ARGS]...\u001b[0m\u001b[1m                                   \u001b[0m\u001b[1m \u001b[0m\n",
      "\u001b[1m                                                                                \u001b[0m\n",
      " DAWSONIA: Digitize hAndWritten obServatiONs In weather journAls (version       \n",
      " 0.0.2b0)This is the main command which provides subcommands for different      \n",
      " stages of the pipeline                                                         \n",
      "                                                                                \n",
      "\u001b[2m╭─\u001b[0m\u001b[2m Options \u001b[0m\u001b[2m───────────────────────────────────────────────────────────────────\u001b[0m\u001b[2m─╮\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36m-\u001b[0m\u001b[1;36m-install\u001b[0m\u001b[1;36m-completion\u001b[0m            Install completion for the current shell.    \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36m-\u001b[0m\u001b[1;36m-show\u001b[0m\u001b[1;36m-completion\u001b[0m               Show completion for the current shell, to    \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m                                 copy it or customize the installation.       \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36m-\u001b[0m\u001b[1;36m-help\u001b[0m                \u001b[1;32m-h\u001b[0m        Show this message and exit.                  \u001b[2m│\u001b[0m\n",
      "\u001b[2m╰──────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n",
      "\u001b[2m╭─\u001b[0m\u001b[2m Commands \u001b[0m\u001b[2m──────────────────────────────────────────────────────────────────\u001b[0m\u001b[2m─╮\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36mdigitize \u001b[0m\u001b[1;36m \u001b[0m Digitize PDF / ZARR into a dataframe using a trained ML model and \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36m          \u001b[0m write it out.                                                     \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36mlabel    \u001b[0m\u001b[1;36m \u001b[0m Label PDF images to create raw training data.                     \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36mml       \u001b[0m\u001b[1;36m \u001b[0m MLops: transform data, train, test                                \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36mprepare  \u001b[0m\u001b[1;36m \u001b[0m Creates new train, validation, test and ground truth text files   \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36m          \u001b[0m for the HTR network and copies in image as input data for the     \u001b[2m│\u001b[0m\n",
      "\u001b[2m│\u001b[0m \u001b[1;36m          \u001b[0m model.                                                            \u001b[2m│\u001b[0m\n",
      "\u001b[2m╰──────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n",
      "\n"
     ]
    }
   ],
   "source": [
    "!dawsonia --help"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "5c5d6c08-264c-4c14-b304-cd4a35344dfc",
   "metadata": {},
   "source": [
    "If not try another installation method or reach out to us (see the \"Chat with us\" link above).\n",
    "\n",
    "```{button-link} ./install.html\n",
    ":color: info\n",
    ":shadow:\n",
    "⏪ Go back to Installation\n",
    "```"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "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.9.13"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}