deploy: dae5e0b

PREP-NexT · Jul 1, 2023 · 1daa52d · 1daa52d
commit 1daa52d
Show file tree

Hide file tree

Showing 190 changed files with 28,698 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 72f951d6feb2818df40bf20deee8a40f
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/404.html b/404.html
@@ -0,0 +1,213 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Page not found &mdash; PREP-SHOT (latest) documentation in English</title>
+      <link rel="stylesheet" href="/_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="/_static/css/theme.css" type="text/css" />
+      <link rel="stylesheet" href="/_static/tabs.css" type="text/css" />
+      <link rel="stylesheet" href="/_static/css/algolia.css" type="text/css" />
+      <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" type="text/css" />
+      <link rel="stylesheet" href="/_static/css/custom.css?5" type="text/css" />
+      <link rel="stylesheet" href="/_static/css/dev.css" type="text/css" />
+    <link rel="shortcut icon" href="/_static/logo.png"/>
+  <!--[if lt IE 9]>
+    <script src="/_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="#" id="documentation_options" src="/_static/documentation_options.js"></script>
+        <script src="/_static/jquery.js"></script>
+        <script src="/_static/underscore.js"></script>
+        <script src="/_static/doctools.js"></script>
+        <script src="/_static/tabs.js"></script>
+        <script src="/_static/js/custom.js?3"></script>
+        <script defer="defer" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
+        <script defer="defer" src="/_static/js/algolia.js"></script>
+    <script src="/_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="/genindex.html" />
+    <link rel="search" title="Search" href="/search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+            <a href="/index.html">
+            <img src="/_static/SVG-03.svg" class="logo" alt="Logo"/>
+          </a>
+              <div class="version">
+                latest
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="/search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="/Installation.html">Installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="/Installation.html#standard-installation">Standard Installation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-1-install-gurobi">Step 1: Install Gurobi</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-2-install-miniconda">Step 2: Install Miniconda</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-3-create-the-conda-environment">Step 3: Create the Conda Environment</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-4-run-the-model">Step 4: Run the Model</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="/Installation.html#installation-on-hpc-systems">Installation on HPC Systems</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-1-load-gurobi">Step 1: Load Gurobi</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-2-load-miniconda">Step 2: Load Miniconda</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#id2">Step 3: Create the Conda Environment</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#id3">Step 4: Run the Model</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="/Installation.html#manual-installation">Manual Installation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-1-install-python">Step 1: Install Python</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-2-install-gurobi">Step 2: Install Gurobi</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#step-3-install-packages">Step 3: Install Packages</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Installation.html#id5">Step 4: Run the Model</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="/Installation.html#troubleshooting">Troubleshooting</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="/Getting_started.html">Getting Started</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="/Getting_started.html#introduction-to-prep-shot">Introduction to PREP-SHOT</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Getting_started.html#origins">Origins</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Getting_started.html#model-capabilities">Model Capabilities</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Getting_started.html#user-prerequisites">User Prerequisites</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="/Getting_started.html#model-concepts">Model Concepts</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Getting_started.html#understanding-energy-expansion">Understanding Energy Expansion</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Getting_started.html#efficiency-and-heat-rate">Efficiency and Heat Rate</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Getting_started.html#id1">Heat Content</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="/Getting_started.html#model-calculations">Model Calculations</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Getting_started.html#electricity-generation-costs">Electricity Generation Costs</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Getting_started.html#power-plant-efficiency">Power Plant Efficiency</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="/User_guide.html">Users Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="/User_guide.html#parameter-representation">Parameter Representation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/User_guide.html#preparing-inputs">Preparing Inputs</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/User_guide.html#tuning-model-parameters">Tuning Model Parameters</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/User_guide.html#reading-the-output">Reading the Output</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="/Tutorial.html">Tutorial</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="/Tutorial.html#scenario-background">Scenario Background</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/Tutorial.html#run-the-model">Run the Model</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Tutorial.html#step-1-download-prep-shot">Step 1: Download PREP-SHOT</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Tutorial.html#step-2-create-the-conda-environment">Step 2: Create the Conda Environment</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Tutorial.html#step-3-download-input-files">Step 3: Download Input Files</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Tutorial.html#step-4-run-the-model">Step 4: Run the Model</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="/Mathematical_notations.html">Mathematical Notations</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="/Mathematical_notations.html#unit-list">Unit List</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/Mathematical_notations.html#set-list">Set List</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/Mathematical_notations.html#variable-list">Variable List</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/Mathematical_notations.html#parameter-list">Parameter List</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/Mathematical_notations.html#objective-functions">Objective Functions</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#costs">Costs</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#factors">Factors</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="/Mathematical_notations.html#constraints">Constraints</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#retirement">Retirement</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#carbon-emission">Carbon Emission</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#power-balance">Power Balance</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#transmission-loss">Transmission Loss</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#maximum-output">Maximum Output</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#energy-storage">Energy Storage</a></li>
+<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#ramping-ratio">Ramping Ratio</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="/Changelog.html">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="/Changelog.html#version-0-1-today">Version 0.1 - Jul 01, 2023</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/Changelog.html#contributing-to-prep-shot">Contributing to PREP-SHOT</a></li>
+<li class="toctree-l2"><a class="reference internal" href="/Changelog.html#contact-us">Contact Us</a></li>
+</ul>
+</li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="/index.html">PREP-SHOT</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="/index.html" class="icon icon-home"></a></li>
+      <li class="breadcrumb-item active">Page not found</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+
+        <h1>Page not found</h1>
+        <p>
+            Sorry, we couldn't find that page. It may have been renamed or removed
+            in the version of the documentation you're currently browsing.
+        </p>
+        <p>
+            If you're currently browsing the
+            <em>latest</em> version of the documentation, try browsing the
+            <a href="/en/stable/"><em>stable</em> version of the documentation</a>.
+        </p>
+        <p>
+            Alternatively, use the
+            <a href="#" onclick="$('#rtd-search-form [name=\'q\']').focus()">Search docs</a>
+            box on the left or <a href="/">go to the homepage</a>.
+        </p>
+
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, Zhanwei Liu and Xiaogang He (CC BY 3.0).</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>