{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "d67a71fa",
   "metadata": {},
   "source": [
    "(contract)=\n",
    "# contract\n",
    "Represents a financial market contract which allows for additional buying and selling of power outside the market\n",
    "\n",
    "|   |   |\n",
    "|---|---|\n",
    "|Input connections|{ref}`busbar`|\n",
    "|Output connections|{ref}`busbar`|\n",
    "|License|SHOP_CONTRACT|\n",
    "|Release version|13.0.0.a|\n",
    "\n",
    "```{contents}\n",
    ":local:\n",
    ":depth: 1\n",
    "```\n",
    "\n",
    "\n",
    "\n",
    "## Examples\n",
    "  - [](ramping)\n",
    "  \n",
    "\n",
    "\n",
    "\n",
    "## Attributes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "6e791698",
   "metadata": {
    "tags": [
     "remove-input",
     "full-width"
    ]
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<table id=\"contract-table\" class=\"display compact\"></table>\n",
       "<script>\n",
       "enableDataTable(\n",
       "  \"#contract-table\",\n",
       "  \"/_static/data/contract-attribute-table.json\"\n",
       ");\n",
       "</script>\n"
      ],
      "text/plain": [
       "<IPython.core.display.HTML object>"
      ]
     },
     "execution_count": 1,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from IPython.core.display import HTML\n",
    "HTML(\"\"\"<table id=\"contract-table\" class=\"display compact\"></table>\n",
    "<script>\n",
    "enableDataTable(\n",
    "  \"#contract-table\",\n",
    "  \"/_static/data/contract-attribute-table.json\"\n",
    ");\n",
    "</script>\n",
    "\"\"\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b37a7821",
   "metadata": {},
   "source": [
    "(contract:initial_trade)=\n",
    "### initial_trade\n",
    "The amount of power traded on the contract right before the optimization horizon begins, only used to implement ramping constraints for the first time step. If this value is not specified (default value 1e40), no ramping constraints are built for the first time step (xUnit: MW, yUnit: MW)\n",
    "\n",
    "\n",
    "(contract:trade_curve)=\n",
    "### trade_curve\n",
    "The trade_curve defines the size and price of the sale (negative volume) and buy (positive volume) steps of the financial contract. The X values of each XY table represents a step curve of volumes that can be traded, while the Y values defines the price for each volume step. Each XY table is valid from the specified start time until the start time of a later XY table is reached (xUnit: MW, yUnit: NOK/MWH)\n",
    "\n",
    "\n",
    "(contract:min_trade)=\n",
    "### min_trade\n",
    "The minimum amount of power that must be traded on this contract, can be a negative number (xUnit: NO_UNIT, yUnit: MW)\n",
    "\n",
    "\n",
    "(contract:max_trade)=\n",
    "### max_trade\n",
    "The maximum amount of power that must be traded on this contract, can be a negative number (xUnit: NO_UNIT, yUnit: MW)\n",
    "\n",
    "\n",
    "(contract:ramping_up)=\n",
    "### ramping_up\n",
    "The limit for ramping up the power traded in the contract between time steps. The ramping up constraints are hard limits if ramping_up_penalty_cost is not specified on the contract (xUnit: NO_UNIT, yUnit: MW_HOUR)\n",
    "\n",
    "\n",
    "(contract:ramping_down)=\n",
    "### ramping_down\n",
    "The limit for ramping down the power traded in the contract between time steps. The ramping down constraints are hard limits if ramping_down_penalty_cost is not specified on the contract (xUnit: NO_UNIT, yUnit: MW_HOUR)\n",
    "\n",
    "\n",
    "(contract:ramping_up_penalty_cost)=\n",
    "### ramping_up_penalty_cost\n",
    "The cost of breaking the ramping up constraints (xUnit: NO_UNIT, yUnit: NOK/MW)\n",
    "\n",
    "\n",
    "(contract:ramping_down_penalty_cost)=\n",
    "### ramping_down_penalty_cost\n",
    "The cost of breaking the ramping down constraints (xUnit: NO_UNIT, yUnit: NOK/MW)\n",
    "\n",
    "\n",
    "(contract:trade)=\n",
    "### trade\n",
    "The total amount of power traded on the contract (xUnit: NO_UNIT, yUnit: MW)\n",
    "\n",
    "\n",
    "(contract:ramping_up_penalty)=\n",
    "### ramping_up_penalty\n",
    "The penalty for breaking the upward ramping constraints on the contract (xUnit: NO_UNIT, yUnit: NOK)\n",
    "\n",
    "\n",
    "(contract:ramping_down_penalty)=\n",
    "### ramping_down_penalty\n",
    "The penalty for breaking the downward ramping constraints on the contract (xUnit: NO_UNIT, yUnit: NOK)"
   ]
  }
 ],
 "metadata": {
  "jupytext": {
   "text_representation": {
    "extension": ".md",
    "format_name": "myst",
    "format_version": 0.13,
    "jupytext_version": "1.13.8"
   }
  },
  "kernelspec": {
   "display_name": "Python 3",
   "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.9"
  },
  "source_map": [
   11,
   38,
   50
  ]
 },
 "nbformat": 4,
 "nbformat_minor": 5
}