{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "6503a467",
   "metadata": {},
   "source": [
    "# Example 1"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "33d91984-c9fa-4ecb-aedd-af44ec5d759e",
   "metadata": {},
   "source": [
    "### Import libraries"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "58f1d6b3",
   "metadata": {},
   "source": []
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "42bc699e-c488-45c0-a489-992d658884d6",
   "metadata": {},
   "outputs": [],
   "source": [
    "import numpy as np\n",
    "import hyveopt as h2\n",
    "\n",
    "# Set np.random seed for reproducibility\n",
    "np.random.seed(0)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "3483ac6b-1736-4198-b534-0837285d4c69",
   "metadata": {},
   "source": [
    "### Create system components templates"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "35ce34a9-937f-49cf-b32b-e8493a564682",
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "0"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "plant_template = h2.PlantTemplate(\n",
    "    name=\"myplant\",\n",
    "    location=(\"22°10'17.66\\\"S\", \"70° 5'23.50\\\"W\") # ~ Tocopilla, Chile.\n",
    ")\n",
    "\n",
    "electrolizer_efficiency = h2.Gain(\n",
    "    breakpoints = [0.0, 0.1, 0.4, 0.7, 1], \n",
    "    slopes = [0.,2., 0.5, 0.2],      \n",
    "    intercepts = [0.0, -0.1, 0.5, 0.8] \n",
    ")\n",
    "\n",
    "plant_template.add(h2.TemplateElectrolizer(\n",
    "    name=\"electrolizer\",\n",
    "    pnom_kW=h2.Range(0., 200.),\n",
    "    gain=electrolizer_efficiency,\n",
    "    inv_cost_per_kw=1300.\n",
    "    )\n",
    ")\n",
    "\n",
    "plant_template.add(h2.TemplateESS(\n",
    "    name=\"battery\",\n",
    "    pnom_kW=h2.Range(0., 200.),\n",
    "    soc_nom_kWh=h2.Range(0., 100.),\n",
    "    inv_cost_per_kw=200.,\n",
    "    bat_kw_to_kwh=3.\n",
    "))\n",
    "\n",
    "plant_template.add(h2.TemplatePVSystem(\n",
    "    name=\"pv_system\",\n",
    "    snom_KVA=h2.Range(0., 200.),\n",
    "    solar_irradiance=h2.TSParameter(tsname=\"si_pv_system\", default=0.0),\n",
    "    inv_cost_per_kw=1100.\n",
    "))\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b4a2a7f6-faa2-491b-9a95-8161a92392c9",
   "metadata": {},
   "source": [
    "### Planning horizon definition and time series data generation"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "2d98b85d-8197-4f03-a5ef-332984fea386",
   "metadata": {},
   "outputs": [],
   "source": [
    "\n",
    "time_config = h2.PlanningTimeConfig(\n",
    "    planning_horizon_start='2025-01-01',\n",
    "    planning_horizon_end='2065-12-31',\n",
    "    scenarios_per_year=2,\n",
    "    scenario_resolution='1D',\n",
    "    scenario_subsampling='1h'  # Sampling frequency for simulation purposes.\n",
    ")\n",
    "\n",
    "tsdata = h2.SingleBusDesignData.generate_tsdata(plant_template, time_config)\n",
    "    "
   ]
  },
  {
   "cell_type": "markdown",
   "id": "dd3d57e0-deb3-4c39-9fd2-244c8e24c79b",
   "metadata": {},
   "source": [
    "### Create and solve sizing model"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "d60cb654-5a2c-4275-8fc6-3f88377ba5fd",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "feasible solution found by trivial heuristic after 0.1 seconds, objective value 0.000000e+00\n",
      "presolving:\n",
      "(round 1, fast)       996 del vars, 996 del conss, 0 add conss, 9843 chg bounds, 0 chg sides, 0 chg coeffs, 0 upgd conss, 0 impls, 0 clqs\n",
      "   (0.2s) dualsparsify: 996 nonzeros canceled\n",
      "(round 2, exhaustive) 996 del vars, 996 del conss, 0 add conss, 9844 chg bounds, 0 chg sides, 2988 chg coeffs, 0 upgd conss, 0 impls, 0 clqs\n",
      "(round 3, fast)       1992 del vars, 1992 del conss, 0 add conss, 11836 chg bounds, 0 chg sides, 2988 chg coeffs, 0 upgd conss, 0 impls, 0 clqs\n",
      "(round 4, fast)       2988 del vars, 2988 del conss, 0 add conss, 11836 chg bounds, 0 chg sides, 2988 chg coeffs, 0 upgd conss, 0 impls, 0 clqs\n",
      "   (0.3s) symmetry computation started: requiring (bin +, int +, cont +), (fixed: bin -, int -, cont -)\n",
      "   (0.4s) symmetry computation finished: 21 generators found (max: 1500, log10 of symmetry group size: 0.0) (symcode time: 0.01)\n",
      "dynamic symmetry handling statistics:\n",
      "   orbitopal reduction:        2 components: 75x3, 81x4\n",
      "   orbital reduction:         no components\n",
      "   lexicographic reduction:   16 permutations with support sizes 174, 186, 162, 174, 186, 186, 150, 162, 162, 186, 150, 150, 174, 186, 162, 150\n",
      "handled 18 out of 18 symmetry components\n",
      "presolving (5 rounds: 5 fast, 2 medium, 2 exhaustive):\n",
      " 2988 deleted vars, 2988 deleted constraints, 0 added constraints, 11836 tightened bounds, 0 added holes, 0 changed sides, 2988 changed coefficients\n",
      " 0 implications, 0 cliques\n",
      "presolved problem has 6856 variables (0 bin, 0 int, 0 impl, 6856 cont) and 10790 constraints\n",
      "  10790 constraints of type <linear>\n",
      "Presolving Time: 0.34\n",
      "transformed 1/1 original solutions to the transformed problem space\n",
      "\n",
      " time | node  | left  |LP iter|LP it/n|mem/heur|mdpt |vars |cons |rows |cuts |sepa|confs|strbr|  dualbound   | primalbound  |  gap   | compl. \n",
      "* 4.2s|     1 |     0 | 12213 |     - |    LP  |   0 |6856 |  10k|  10k|   0 |  0 |   0 |   0 | 3.620433e+07 | 3.620433e+07 |   0.00%| unknown\n",
      "  4.2s|     1 |     0 | 12213 |     - |   112M |   0 |6856 |  10k|  10k|   0 |  0 |   0 |   0 | 3.620433e+07 | 3.620433e+07 |   0.00%| unknown\n",
      "\n",
      "SCIP Status        : problem is solved [optimal solution found]\n",
      "Solving Time (sec) : 4.16\n",
      "Solving Nodes      : 1\n",
      "Primal Bound       : +3.62043337104110e+07 (2 solutions)\n",
      "Dual Bound         : +3.62043337104110e+07\n",
      "Gap                : 0.00 %\n"
     ]
    }
   ],
   "source": [
    "\n",
    "pdata = h2.SingleBusDesignData(\n",
    "    budget_inv_M=10.,\n",
    "    plant_template=plant_template,\n",
    "    time_config=time_config,\n",
    "    tsdata=tsdata\n",
    ")\n",
    "\n",
    "model = h2.SingleBusDesignModel(pdata)\n",
    "\n",
    "model.solve()"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "60e7d51c",
   "metadata": {},
   "source": [
    "### Report solution"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "7d9fcc9c",
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "*************************\n",
      "Solution Report\n",
      "*************************\n",
      "SIZING:\n",
      "Electrolyzer size: 1920.86 kW\n",
      "PV size: 5923.50 kW\n",
      "Battery size: 4.94 MW, 14.81 MWh\n",
      "\n",
      "\n",
      "FINANCIALS:\n",
      "NPV: 36204333.71 USD\n"
     ]
    }
   ],
   "source": [
    "model.report()"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "new",
   "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.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}