-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 5168e34
Showing
213 changed files
with
32,488 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: 48fbeb374d257c51f0b0e3fff38bec7d | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,303 @@ | ||
<!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 — 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/_sphinx_javascript_frameworks_compat.js"></script> | ||
<script src="/_static/doctools.js"></script> | ||
<script src="/_static/sphinx_highlight.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><meta name="theme-color" content="#3d8fcc"> | ||
|
||
<link rel="index" title="Index" href="/genindex.html" /> | ||
<link rel="search" title="Search" href="/search.html" /> | ||
<meta name="doc_version" content="latest"> | ||
<meta name="doc_is_latest" content=""> | ||
|
||
</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="/index.html">Overview</a></li> | ||
<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#step-1-download-prep-shot">Step 1: Download PREP-SHOT</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Installation.html#step-2-install-conda">Step 2: Install conda</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Installation.html#step-3-install-dependencies">Step 3: Install dependencies</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Installation.html#step-4-run-an-example-optional">Step 4: Run an example (Optional)</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Installation.html#step-5-run-your-own-model">Step 5: Run your own model</a></li> | ||
</ul> | ||
</li> | ||
<li class="toctree-l1"><a class="reference internal" href="/Model_input_output.html">Model Inputs/Outputs</a><ul> | ||
<li class="toctree-l2"><a class="reference internal" href="/Model_input_output.html#inputs">Inputs</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Model_input_output.html#outputs">Outputs</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Model_input_output.html#execute-various-scenarios">Execute various scenarios</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Model_input_output.html#setting-global-parameters">Setting global parameters</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> | ||
</ul> | ||
</li> | ||
<li class="toctree-l1"><a class="reference internal" href="/Mathematical_notations.html">Mathematical Notation</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">Transmission</a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#power-output">Power Output</a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#power-output-variation">Power output variation</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#water-balance">Water balance</a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#reservoir-outflow">Reservoir outflow</a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/Mathematical_notations.html#reservoir-storage">Reservoir storage</a></li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</li> | ||
<li class="toctree-l1"><a class="reference internal" href="/Forum.html">Discussion</a><ul> | ||
<li class="toctree-l2"><a class="reference internal" href="/Forum.html#github-discussions">GitHub Discussions</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Forum.html#private-queries">Private Queries</a></li> | ||
</ul> | ||
</li> | ||
<li class="toctree-l1"><a class="reference internal" href="/Contribution.html">Contribution</a><ul> | ||
<li class="toctree-l2"><a class="reference internal" href="/Contribution.html#development-process">Development Process</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Contribution.html#building-documentation">Building Documentation</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Contribution.html#contributing-guidelines">Contributing Guidelines</a></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-0-jun-24-2024">Version 0.1.0 - Jun 24, 2024</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/Changelog.html#version-0-1-1-jun-24-2024">Version 0.1.1 - Jun 24, 2024</a><ul> | ||
<li class="toctree-l3"><a class="reference internal" href="/Changelog.html#added">Added</a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/Changelog.html#fixed">Fixed</a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/Changelog.html#changed">Changed</a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/Changelog.html#deprecated">Deprecated</a></li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</li> | ||
<li class="toctree-l1"><a class="reference internal" href="/api/prepshot.html">API Reference</a><ul> | ||
<li class="toctree-l2"><a class="reference internal" href="/api/prepshot.load_data.html">PREP-SHOT.load_data</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/api/prepshot.logs.html">PREP-SHOT.logs</a><ul> | ||
<li class="toctree-l3"><a class="reference internal" href="/api/prepshot.logs.html#prepshot.logs.log_parameter_info"><code class="docutils literal notranslate"><span class="pre">log_parameter_info()</span></code></a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/api/prepshot.logs.html#prepshot.logs.setup_logging"><code class="docutils literal notranslate"><span class="pre">setup_logging()</span></code></a></li> | ||
<li class="toctree-l3"><a class="reference internal" href="/api/prepshot.logs.html#prepshot.logs.timer"><code class="docutils literal notranslate"><span class="pre">timer()</span></code></a></li> | ||
</ul> | ||
</li> | ||
<li class="toctree-l2"><a class="reference internal" href="/api/prepshot.model.html">PREP-SHOT.model</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/api/prepshot.parameters.html">PREP-SHOT.parameters</a><ul> | ||
<li class="toctree-l3"><a class="reference internal" href="/api/prepshot.parameters.html#prepshot.parameters.parse_arguments"><code class="docutils literal notranslate"><span class="pre">parse_arguments()</span></code></a></li> | ||
</ul> | ||
</li> | ||
<li class="toctree-l2"><a class="reference internal" href="/api/prepshot.rules.html">PREP-SHOT.rules</a></li> | ||
<li class="toctree-l2"><a class="reference internal" href="/api/prepshot.utils.html">PREP-SHOT.utils</a></li> | ||
</ul> | ||
</li> | ||
<li class="toctree-l1"><a class="reference internal" href="/References.html">References</a></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> | ||
<div style="font-size: 105%;font-weight: 600;"> | ||
|
||
</div> | ||
<ul class="wy-breadcrumbs"> | ||
|
||
<li><a href="/index.html" class="icon icon-home"></a></li> | ||
<li class="breadcrumb-item active">Page not found</li> | ||
</ul> | ||
</li> | ||
|
||
|
||
<li style="float: right; text-align: right;"> | ||
<ul> | ||
|
||
<li class="wy-breadcrumbs-aside"> | ||
</li> | ||
</ul> | ||
|
||
<style> | ||
.godot-edit-guidelines { | ||
font-size: 14px; | ||
float: right; | ||
clear: both; | ||
padding-top: 4px; | ||
} | ||
|
||
@media screen and (max-width: 480px) { | ||
.godot-edit-guidelines { | ||
display: none; | ||
} | ||
} | ||
</style> | ||
<a class="godot-edit-guidelines" href="https://prep-next.github.io/PREP-SHOT/Changelog.html#contributing-to-prep-shot"> | ||
Learn how to contribute! | ||
</a> | ||
</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>© 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> | ||
|
||
<!-- , "de":"#", "es":"#", "fr":"#" --> | ||
|
||
|
||
|
||
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> | ||
<span class="rst-current-version" data-toggle="rst-current-version"> | ||
<span class="fa fa-book"> Read the Docs</span> | ||
<!-- v: latest () --> | ||
<!-- v: 0.1 --> | ||
latest | ||
<span class="fa fa-caret-down"></span> | ||
</span> | ||
<div class="rst-other-versions"> | ||
|
||
|
||
<dl> | ||
<dt>Languages</dt> | ||
|
||
<dd><a href="#">en</a></dd> | ||
|
||
</dl> | ||
<!-- <dl> | ||
<dt>Versions</dt> | ||
<dd><a href="#">stable</a></dd> | ||
<dd><a href="#">latest</a></dd> | ||
</dl> --> | ||
<dl> | ||
|
||
<dt>On Read the Docs</dt> | ||
<dd> | ||
<a href="https://github.com/PREP-NexT/PREP-SHOT/tree/main">Project Home</a> | ||
</dd> | ||
<!-- <dd> | ||
<a href="///projects//builds/">Builds</a> | ||
</dd> --> | ||
<dd> | ||
<a href="https://github.com/PREP-NexT/PREP-SHOT/raw/gh-pages/_static/PREP-SHOT.pdf">PDF</a> | ||
</dd> | ||
</dl> | ||
|
||
<hr> | ||
<small> | ||
<span>Hosted by <a href="https://readthedocs.org">Read the Docs</a></span> | ||
<span> · </span> | ||
<a href="https://docs.readthedocs.io/page/privacy-policy.html">Privacy Policy</a> | ||
</small> | ||
|
||
|
||
</div> | ||
</div><script> | ||
jQuery(function () { | ||
SphinxRtdTheme.Navigation.enable(true); | ||
}); | ||
</script> | ||
|
||
</body> | ||
</html> |
Oops, something went wrong.