{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "5556432f",
   "metadata": {},
   "source": [
    "# Tutorial 50: Mantle_SIR3S_Model "
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8899e69a",
   "metadata": {},
   "source": [
    "This Example demonstrates how to initialize the SIR 3S Toolkit and instantiate the SIR3S_Model_Dataframes() class."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "e2d40c36",
   "metadata": {},
   "source": [
    "# Toolkit Release"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 17,
   "id": "7fb5a07b",
   "metadata": {},
   "outputs": [],
   "source": [
    "#pip install "
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d6773e12",
   "metadata": {},
   "source": [
    "# Imports"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "134689cf",
   "metadata": {},
   "source": [
    "## SIR 3S Toolkit"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "69665f68",
   "metadata": {},
   "source": [
    "### Regular Import/Init"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 18,
   "id": "79d0fb2c",
   "metadata": {},
   "outputs": [],
   "source": [
    "SIR3S_SIRGRAF_DIR = r\"C:\\3S\\SIR 3S\\SirGraf-90-15-00-20x64_Quebec-Upd1\" #change to local path"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 19,
   "id": "0f41d17a",
   "metadata": {},
   "outputs": [],
   "source": [
    "from sir3stoolkit.core import wrapper"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 20,
   "id": "d539c981",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "<module 'sir3stoolkit.core.wrapper' from 'C:\\\\Users\\\\aUsername\\\\3S\\\\sir3stoolkit\\\\src\\\\sir3stoolkit\\\\core\\\\wrapper.py'>"
      ]
     },
     "execution_count": 20,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "wrapper"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 21,
   "id": "37d59df0",
   "metadata": {},
   "outputs": [],
   "source": [
    "wrapper.Initialize_Toolkit(SIR3S_SIRGRAF_DIR)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ebf2c56e",
   "metadata": {},
   "source": [
    "### Additional Import/Init for Dataframes class"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "cddffdc6",
   "metadata": {},
   "source": [
    "We can instantiate the individual classes that are part of the mantle for SIR3S_Model() to get their respective capabilities. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 22,
   "id": "893f889e",
   "metadata": {},
   "outputs": [],
   "source": [
    "from sir3stoolkit.mantle.dataframes import SIR3S_Model_Dataframes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 23,
   "id": "adeb8672",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Initialization complete\n"
     ]
    }
   ],
   "source": [
    "s3s = SIR3S_Model_Dataframes()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 24,
   "id": "304cdc37",
   "metadata": {},
   "outputs": [],
   "source": [
    "from sir3stoolkit.mantle.alternative_models import SIR3S_Model_Alternative_Models"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 25,
   "id": "fa3672d1",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Initialization complete\n"
     ]
    }
   ],
   "source": [
    "s3s = SIR3S_Model_Alternative_Models()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 26,
   "id": "72131874",
   "metadata": {},
   "outputs": [],
   "source": [
    "from sir3stoolkit.mantle.plotting import SIR3S_Model_Plotting"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 27,
   "id": "0d84564d",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Initialization complete\n"
     ]
    }
   ],
   "source": [
    "s3s = SIR3S_Model_Plotting()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "037ed685",
   "metadata": {},
   "source": [
    "or we can instantiate a collector class with capabilities of all above mentioned classes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 29,
   "id": "11f9407d",
   "metadata": {},
   "outputs": [],
   "source": [
    "from sir3stoolkit.mantle.mantle import SIR3S_Model_Mantle"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 30,
   "id": "4b65297f",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Initialization complete\n"
     ]
    }
   ],
   "source": [
    "s3s = SIR3S_Model_Mantle()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "afa33a74",
   "metadata": {},
   "source": [
    "__Next:__ Tutorial 6: Miscellaneous Tutorial 51: Dataframe Creation"
   ]
  }
 ],
 "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.11.8"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}