{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Installation Guide\n",
    "\n",
    "This notebook covers installation of QCMet and its dependencies."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Requirements\n",
    "\n",
    "QCMet requires Python 3.10 or higher.\n",
    "\n",
    "## Basic Installation\n",
    "\n",
    "Clone the repository, and install QCMet and its dependencies using pip (inside the QCMet root folder):\n",
    "\n",
    "```bash\n",
    "pip install -e .\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Optional Dependencies\n",
    "\n",
    "\n",
    "### Development Tools\n",
    "\n",
    "```bash\n",
    "pip install -e .[dev]\n",
    "```\n",
    "\n",
    "### All Optional Dependencies\n",
    "\n",
    "```bash\n",
    "pip install -e .[dev,docs,lint]\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Verifying Installation\n",
    "\n",
    "Let's verify that QCMet is installed correctly:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "QCMet version: 1.0.0\n"
     ]
    }
   ],
   "source": [
    "import qcmet\n",
    "print(f\"QCMet version: {qcmet.__version__}\")"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Testing the Installation\n",
    "\n",
    "Let's run a simple test to ensure everything works:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "jupyter": {
     "is_executing": true
    }
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Generated 10 circuits\n",
      "QCMet is working correctly!\n"
     ]
    }
   ],
   "source": [
    "from qcmet import T1\n",
    "from qcmet.devices import IdealSimulator\n",
    "\n",
    "# Create a simple T1 benchmark\n",
    "simulator = IdealSimulator()\n",
    "t1 = T1()\n",
    "\n",
    "# Generate circuits\n",
    "t1.generate_circuits()\n",
    "print(f\"Generated {len(t1.circuits)} circuits\")\n",
    "print(\"QCMet is working correctly!\")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "base",
   "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.10"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}