![](\"files/Julia.png\")
"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "14bd5e78",
+ "metadata": {},
+ "source": [
+ "If you don't already have the package IJulia, add it here using `import(Pkg); Pkg.add(\"IJulia\")`:"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "50fe200d",
+ "metadata": {},
+ "source": [
+ "![](\"files/addIJulia.png\")
"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "0e1b2998",
+ "metadata": {},
+ "source": [
+ "After IJulia is added, open a Jupyter notebook with `using IJulia; notebook()`:"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "af32af4d",
+ "metadata": {},
+ "source": [
+ "![](\"files/opennotebook.png\")
"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "762ecdbb",
+ "metadata": {},
+ "source": [
+ "This will open a notebook in your default browser. From there, navigate through the GenX directory to the `Tutorials` folder and you're good to go!"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "97b2b84b",
+ "metadata": {},
+ "source": [
+ "![](\"files/jupyter_screen.png\")
"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "c6ada492",
+ "metadata": {},
+ "source": [
+ "**For a more detailed explanation of IJulia, Jupyter, and downloading packages, see here.**"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Julia 1.9.2",
+ "language": "julia",
+ "name": "julia-1.9"
+ },
+ "language_info": {
+ "file_extension": ".jl",
+ "mimetype": "application/julia",
+ "name": "julia",
+ "version": "1.9.2"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
diff --git a/Tutorials/.ipynb_checkpoints/Tutorial_1_Configuring_Settings-checkpoint.ipynb b/Tutorials/.ipynb_checkpoints/Tutorial_1_Configuring_Settings-checkpoint.ipynb
new file mode 100644
index 0000000000..c687f7ae89
--- /dev/null
+++ b/Tutorials/.ipynb_checkpoints/Tutorial_1_Configuring_Settings-checkpoint.ipynb
@@ -0,0 +1,373 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "id": "78a5ccd4-f602-4381-aadc-d468cff03ba3",
+ "metadata": {},
+ "source": [
+ "# Tutorial 1: Configuring Settings"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "c78bfdbd",
+ "metadata": {},
+ "source": [
+ "GenX is easy to customize to fit a variety of problems. In this tutorial, we show which settings are available to change, what their defaults are, and how to change them in your code."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "d6814a53",
+ "metadata": {},
+ "source": [
+ "## What settings are there?"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "69655945",
+ "metadata": {},
+ "source": [
+ "There are 21 settings available to edit in GenX, found in the file `genx_settings.yml`. These settings are described here in the documentation. The file is located in the `Settings` folder in the working directory. To change the location of the file, edit the `settings_path` variable in `Run.jl` within your directory."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "6e11cc81",
+ "metadata": {},
+ "source": [
+ "Most settings are set as either 0 or 1, which correspond to whether or not to include a specifc feature. For example, to use `TimeDomainReduction`, you would set its parameter to 0 within `genx_settings.yml`. If you would like to run GenX without it, you would set its parameter to 1."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "4c88b3b9",
+ "metadata": {},
+ "source": [
+ "Other settings, such as `CO2Cap`, have more options corresponding to integers, while some settings such as `ModelingtoGenerateAlternativeSlack` take a numerical input directly (in this case, the slack value). Two settings, `Solver` and `TimeDomainReductionFolder` take in text as input. To learn more about different solvers, read here. For `TimeDomainReductionFolder`, specify the name of the directory you wish to see the results in. For a more comprehensive description of the input options, see the documentation linked above."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "bbd18f76",
+ "metadata": {},
+ "source": [
+ "Below is the settings file for `SmallNewEngland/OneZone`:"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "57ee59c3",
+ "metadata": {},
+ "source": [
+ "![](\"img/genxsettings_onezone.png\")
"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "c37c756e",
+ "metadata": {},
+ "source": [
+ "All `genx_settings.yml` files in `Example_Systems` specify most parameters. When configuring your own settings, however, it is not necessary to input all parameters as defaults are specified for each one in `configure_settings.jl`."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "16ec73eb",
+ "metadata": {},
+ "source": [
+ "![](\"img/default_settings.png\")
"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "527e600d",
+ "metadata": {},
+ "source": [
+ "To open `genx_settings.yml` in Jupyter, use the function `YAML.load(open(...))` and navigate to file in the desired directory:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 14,
+ "id": "751b0e46",
+ "metadata": {},
+ "outputs": [
+ {
+ "data": {
+ "text/plain": [
+ "Dict{Any, Any} with 21 entries:\n",
+ " \"NetworkExpansion\" => 0\n",
+ " \"TimeDomainReductionFolder\" => \"TDR_Results\"\n",
+ " \"ModelingToGenerateAlternativeIterations\" => 3\n",
+ " \"ParameterScale\" => 1\n",
+ " \"EnergyShareRequirement\" => 1\n",
+ " \"PrintModel\" => 0\n",
+ " \"TimeDomainReduction\" => 1\n",
+ " \"Trans_Loss_Segments\" => 1\n",
+ " \"CapacityReserveMargin\" => 1\n",
+ " \"ModelingtoGenerateAlternativeSlack\" => 0.1\n",
+ " \"Solver\" => \"HiGHS\"\n",
+ " \"MethodofMorris\" => 0\n",
+ " \"Reserves\" => 0\n",
+ " \"StorageLosses\" => 1\n",
+ " \"OverwriteResults\" => 0\n",
+ " \"UCommit\" => 2\n",
+ " \"ModelingToGenerateAlternatives\" => 0\n",
+ " \"MaxCapReq\" => 1\n",
+ " \"MinCapReq\" => 1\n",
+ " \"CO2Cap\" => 2\n",
+ " \"WriteShadowPrices\" => 1"
+ ]
+ },
+ "execution_count": 14,
+ "metadata": {},
+ "output_type": "execute_result"
+ }
+ ],
+ "source": [
+ "using YAML\n",
+ "genx_settings_SNE = YAML.load(open(\"../Example_Systems/SmallNewEngland/OneZone/Settings/genx_settings.yml\"))"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "dcdd15fd",
+ "metadata": {},
+ "source": [
+ "Since all settings have defaults, you only need to specify the settings you would like to change. In fact, you can leave your settings file completely blank and it will still run! Let's try editing `genx_settings` in `SmallNewEngland/OneZone` to contain no parameters:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "f1ea1703",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "new_params = Dict() # Empty dictionary\n",
+ "YAML.write_file(\"../Example_Systems/SmallNewEngland/OneZone/Settings/genx_settings.yml\", new_params)"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "fbc6ce5d",
+ "metadata": {},
+ "source": [
+ "The empty file will look like this:"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "e24980d7",
+ "metadata": {},
+ "source": [
+ "![](\"img/genx_settings_none.png\")
"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "67a336a9",
+ "metadata": {},
+ "source": [
+ "Now, run GenX and output the file `capacity.csv` from the `Results` folder:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 9,
+ "id": "236c0180",
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "Configuring Settings\n",
+ "Time Series Data Already Clustered.\n",
+ "Configuring Solver\n",
+ "Loading Inputs\n",
+ "Reading Input CSV Files\n",
+ "Network.csv Successfully Read!\n",
+ "Load_data.csv Successfully Read!\n",
+ "Fuels_data.csv Successfully Read!\n",
+ "Generators_data.csv Successfully Read!\n",
+ "Generators_variability.csv Successfully Read!\n",
+ "Validating time basis\n",
+ "Capacity_reserve_margin.csv Successfully Read!\n",
+ "Minimum_capacity_requirement.csv Successfully Read!\n",
+ "Maximum_capacity_requirement.csv Successfully Read!\n",
+ "Energy_share_requirement.csv Successfully Read!\n",
+ "CO2_cap.csv Successfully Read!\n",
+ "CSV Files Successfully Read In From /Users/mayamutic/Desktop/GenX/Example_Systems/SmallNewEngland/OneZone\n",
+ "Generating the Optimization Model\n",
+ "Discharge Module\n",
+ "Non-served Energy Module\n",
+ "Investment Discharge Module\n",
+ "Unit Commitment Module\n",
+ "Emissions Module (for CO2 Policy modularization\n",
+ "Dispatchable Resources Module\n",
+ "Storage Resources Module\n",
+ "Storage Investment Module\n",
+ "Storage Core Resources Module\n",
+ "Storage Resources with Symmetric Charge/Discharge Capacity Module\n",
+ "Thermal (Unit Commitment) Resources Module\n",
+ "C02 Policies Module\n",
+ "Energy Share Requirement Policies Module\n",
+ "Capacity Reserve Margin Policies Module\n",
+ "Minimum Capacity Requirement Module\n",
+ "Maximum Capacity Requirement Module\n",
+ "Time elapsed for model building is\n",
+ "4.274147083\n",
+ "Solving Model\n",
+ "Running HiGHS 1.6.0: Copyright (c) 2023 HiGHS under MIT licence terms\n",
+ "Presolving model\n",
+ "36012 rows, 17529 cols, 136567 nonzeros\n",
+ "34549 rows, 16070 cols, 136337 nonzeros\n",
+ "Presolve : Reductions: rows 34549(-6123); columns 16070(-2422); elements 136337(-29881)\n",
+ "Solving the presolved LP\n",
+ "Using EKK dual simplex solver - serial\n",
+ " Iteration Objective Infeasibilities num(sum)\n",
+ " 0 -1.9058295039e-01 Ph1: 12(61.9533); Du: 1(0.190583) 0s\n",
+ " 16420 9.7160052378e+03 Pr: 0(0); Du: 0(3.13359e-06) 4s\n",
+ "Using EKK primal simplex solver\n",
+ " Iteration Objective Infeasibilities num(sum)\n",
+ " 16420 9.7160052378e+03 Pr: 0(0); Du: 1(0.000200549) 4s\n",
+ " 16421 9.7160052378e+03 Pr: 0(0); Du: 0(6.09353e-15) 4s\n",
+ "Solving the original LP from the solution after postsolve\n",
+ "Model status : Optimal\n",
+ "Simplex iterations: 16421\n",
+ "Objective value : 9.7160052378e+03\n",
+ "HiGHS run time : 4.25\n",
+ "LP solved for primal\n",
+ "Writing Output\n",
+ "Time elapsed for writing costs is\n",
+ "0.659734\n",
+ "Time elapsed for writing storage is\n",
+ "0.078838791\n",
+ "Time elapsed for writing nse is\n",
+ "0.317711209\n",
+ "Time elapsed for writing power balance is\n",
+ "0.178140584\n",
+ "Time elapsed for writing emissions is\n",
+ "0.30562725\n",
+ "Time elapsed for writing reliability is\n",
+ "0.141396375\n",
+ "Time elapsed for writing storage duals is\n",
+ "0.326884042\n",
+ "Time elapsed for writing commitment is\n",
+ "0.028738458\n",
+ "Time elapsed for writing startup is\n",
+ "0.028648041\n",
+ "Time elapsed for writing shutdown is\n",
+ "0.024390583\n",
+ "Time elapsed for writing time weights is\n",
+ "0.048884292\n",
+ "Time elapsed for writing reserve margin is\n",
+ "0.124729875\n",
+ "Time elapsed for writing capacity value is\n",
+ "1.293372\n",
+ "Time elapsed for writing net revenue is\n",
+ "0.369404208\n",
+ "Wrote outputs to /Users/mayamutic/Desktop/GenX/Example_Systems/SmallNewEngland/OneZone/Results_2\n",
+ "Time elapsed for writing is\n",
+ "7.758552166\n"
+ ]
+ }
+ ],
+ "source": [
+ "include(\"../Example_Systems/SmallNewEngland/OneZone/Run.jl\")"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 13,
+ "id": "b8ea6030",
+ "metadata": {},
+ "outputs": [
+ {
+ "data": {
+ "text/html": [
+ "| Row | Resource | Zone | StartCap | RetCap | NewCap | EndCap | StartEnergyCap | RetEnergyCap | NewEnergyCap | EndEnergyCap | StartChargeCap | RetChargeCap | NewChargeCap | EndChargeCap |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| String31 | String3 | Float64 | Float64 | Float64 | Float64 | Float64 | Float64 | Float64 | Float64 | Float64 | Float64 | Float64 | Float64 | |
| 1 | natural_gas_combined_cycle | 1 | 0.0 | 0.0 | 15113.5 | 15113.5 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 |
| 2 | solar_pv | 1 | 0.0 | 0.0 | 31519.9 | 31519.9 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 |
| 3 | onshore_wind | 1 | 0.0 | 0.0 | 26083.7 | 26083.7 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 |
| 4 | battery | 1 | 0.0 | 0.0 | 8609.66 | 8609.66 | 0.0 | 0.0 | 34158.1 | 34158.1 | 0.0 | 0.0 | 0.0 | 0.0 |
| 5 | Total | n/a | 0.0 | 0.0 | 81326.8 | 81326.8 | 0.0 | 0.0 | 34158.1 | 34158.1 | 0.0 | 0.0 | 0.0 | 0.0 |
| Row | Column1 | Network_zones | Network_Lines | z1 | z2 | z3 | Line_Max_Flow_MW | transmission_path_name | distance_mile | Line_Loss_Percentage | Line_Max_Reinforcement_MW | Line_Reinforcement_Cost_per_MWyr | DerateCapRes_1 | CapRes_1 | CapRes_Excl_1 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| String3 | String3 | String3 | String3 | String3 | String3 | String7 | String15 | String15 | String15 | String7 | String7 | String7 | String3 | Int64? | |
| 1 | MA | z1 | 1 | 1 | -1 | 0 | 2950 | MA_to_CT | 123.0584 | 0.012305837 | 2950 | 12060 | 0.95 | 0 | 0 |
| 2 | CT | z2 | 2 | 1 | 0 | -1 | 2000 | MA_to_ME | 196.5385 | 0.019653847 | 2000 | 19261 | 0.95 | 0 | 0 |
| 3 | ME | z3 | missing |
![](\"files/new_england.png\")
"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "d89f8c96",
+ "metadata": {},
+ "outputs": [],
+ "source": []
+ }
+ ],
+ "metadata": {
+ "@webio": {
+ "lastCommId": "22b36260144444988f1a70d85ef0b17a",
+ "lastKernelId": "0d15a65c-9b8a-4242-bdb1-4d39948d79a9"
+ },
+ "kernelspec": {
+ "display_name": "Julia 1.9.2",
+ "language": "julia",
+ "name": "julia-1.9"
+ },
+ "language_info": {
+ "file_extension": ".jl",
+ "mimetype": "application/julia",
+ "name": "julia",
+ "version": "1.9.2"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
diff --git a/Tutorials/.ipynb_checkpoints/Tutorial_3_K-means_Time_Domain_Reduction-checkpoint.ipynb b/Tutorials/.ipynb_checkpoints/Tutorial_3_K-means_Time_Domain_Reduction-checkpoint.ipynb
new file mode 100644
index 0000000000..cf59fac6f4
--- /dev/null
+++ b/Tutorials/.ipynb_checkpoints/Tutorial_3_K-means_Time_Domain_Reduction-checkpoint.ipynb
@@ -0,0 +1,158764 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "id": "7054e9e0",
+ "metadata": {},
+ "source": [
+ "# Tutorial 3: K-Means and Time Domain Reduction"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "944dff9e",
+ "metadata": {},
+ "source": [
+ "A good tool to reduce computation time of GenX is to use Time Domain Reduction (TDR). Time Domain Reduction is a method that selects a smaller set of time steps from the data in a way that reduces computation time while still capturing the main information of the model. In this tutorial, we go over how TDR works in GenX and how it uses K-means clustering to choose the optimal time steps."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "9cb4e61f",
+ "metadata": {},
+ "source": [
+ "### Time Domain Reduction"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "4456f70f",
+ "metadata": {},
+ "source": [
+ "To see how Time Domain Reduction works, let's look at the `Load_data` in `Example_Systems_Tutorials/SmallNewEngland/OneZone/`:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 301,
+ "id": "5f8730d4",
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stderr",
+ "output_type": "stream",
+ "text": [
+ "\u001b[32m\u001b[1m Updating\u001b[22m\u001b[39m registry at `~/.julia/registries/General.toml`\n",
+ "\u001b[32m\u001b[1m Resolving\u001b[22m\u001b[39m package versions...\n",
+ "\u001b[32m\u001b[1m Installed\u001b[22m\u001b[39m TickTock ─ v1.3.0\n",
+ "\u001b[32m\u001b[1m Updating\u001b[22m\u001b[39m `~/Desktop/GenX/Project.toml`\n",
+ " \u001b[90m[9ff05d80] \u001b[39m\u001b[92m+ TickTock v1.3.0\u001b[39m\n",
+ "\u001b[32m\u001b[1m Updating\u001b[22m\u001b[39m `~/Desktop/GenX/Manifest.toml`\n",
+ " \u001b[90m[9ff05d80] \u001b[39m\u001b[92m+ TickTock v1.3.0\u001b[39m\n",
+ "\u001b[32m\u001b[1mPrecompiling\u001b[22m\u001b[39m project...\n",
+ "\u001b[32m ✓ \u001b[39mTickTock\n",
+ "\u001b[33m ✓ \u001b[39mGenX\n",
+ " 2 dependencies successfully precompiled in 7 seconds. 128 already precompiled.\n",
+ " \u001b[33m1\u001b[39m dependency precompiled but a different version is currently loaded. Restart julia to access the new version\n"
+ ]
+ }
+ ],
+ "source": [
+ "# First, load all packages needed\n",
+ "using DataFrames\n",
+ "using CSV\n",
+ "using VegaLite\n",
+ "using YAML\n",
+ "using TickTock\n",
+ "using PlotlyJS\n",
+ "using Plots\n",
+ "using Clustering\n",
+ "using ScikitLearn\n",
+ "@sk_import datasets: (make_blobs)"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 259,
+ "id": "328f601e",
+ "metadata": {},
+ "outputs": [
+ {
+ "data": {
+ "text/html": [
+ "| Row | Voll | Demand_Segment | Cost_of_Demand_Curtailment_per_MW | Max_Demand_Curtailment | Rep_Periods | Timesteps_per_Rep_Period | Sub_Weights | Time_Index | Load_MW_z1 |
|---|---|---|---|---|---|---|---|---|---|
| String7 | String3 | String3 | String3 | String3 | String7 | String7 | Int64 | Int64 | |
| 1 | 50000 | 1 | 1 | 1 | 1 | 8760 | 8760 | 1 | 11162 |
| 2 | 2 | 10556 | |||||||
| 3 | 3 | 10105 | |||||||
| 4 | 4 | 9878 | |||||||
| 5 | 5 | 9843 | |||||||
| 6 | 6 | 10017 | |||||||
| 7 | 7 | 10390 | |||||||
| 8 | 8 | 10727 | |||||||
| 9 | 9 | 11298 | |||||||
| 10 | 10 | 11859 | |||||||
| 11 | 11 | 12196 | |||||||
| 12 | 12 | 12321 | |||||||
| 13 | 13 | 12381 | |||||||
| ⋮ | ⋮ | ⋮ | ⋮ | ⋮ | ⋮ | ⋮ | ⋮ | ⋮ | ⋮ |
| 8749 | 8749 | 15257 | |||||||
| 8750 | 8750 | 15002 | |||||||
| 8751 | 8751 | 14842 | |||||||
| 8752 | 8752 | 14886 | |||||||
| 8753 | 8753 | 15965 | |||||||
| 8754 | 8754 | 16933 | |||||||
| 8755 | 8755 | 16440 | |||||||
| 8756 | 8756 | 15059 | |||||||
| 8757 | 8757 | 14359 | |||||||
| 8758 | 8758 | 13687 | |||||||
| 8759 | 8759 | 12986 | |||||||
| 8760 | 8760 | 12287 |
| Row | x1 | x2 |
|---|---|---|
| Float64 | Float64 | |
| 1 | -1.72161 | -1.48033 |
| 2 | -7.74065 | -8.61801 |
| 3 | 1.27318 | 0.914331 |
| 4 | -0.778866 | -1.29531 |
| 5 | 7.48006 | 2.49393 |
| 6 | 8.91111 | 9.14933 |
| 7 | -2.27579 | -2.897 |
| 8 | -2.91716 | -0.816103 |
| 9 | 1.78493 | -1.25974 |
| 10 | 7.71891 | 0.991913 |
| 11 | 6.28516 | 11.2872 |
| 12 | 6.53424 | 9.45532 |
| 13 | 8.90864 | 0.97765 |
| ⋮ | ⋮ | ⋮ |
| 89 | 5.51409 | -1.162 |
| 90 | -3.71313 | -9.99476 |
| 91 | -1.90119 | -2.12454 |
| 92 | 0.587433 | -0.813353 |
| 93 | 6.57243 | -1.02614 |
| 94 | 7.63027 | 8.69798 |
| 95 | -1.45137 | -4.38746 |
| 96 | -7.18598 | -9.36698 |
| 97 | -2.60104 | -1.52873 |
| 98 | 7.81296 | -0.534152 |
| 99 | 7.53582 | 0.617749 |
| 100 | -0.203394 | 1.08106 |