generated from cvxgrp/simulator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ 6ac79fa 🚀
- Loading branch information
Showing
39 changed files
with
990 additions
and
144 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
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
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
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,141 @@ | ||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" data-content_root="../../"> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>data.render — cvxbson Documentation</title> | ||
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" /> | ||
| <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" /> | ||
| <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" /> | ||
| <link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=c267ad58" /> | ||
|
|
||
|
|
||
| <!--[if lt IE 9]> | ||
| <script src="../../_static/js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
|
|
||
| <script src="../../_static/jquery.js?v=5d32c60e"></script> | ||
| <script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> | ||
| <script src="../../_static/documentation_options.js?v=5929fcd5"></script> | ||
| <script src="../../_static/doctools.js?v=888ff710"></script> | ||
| <script src="../../_static/sphinx_highlight.js?v=dc90522c"></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" class="icon icon-home"> | ||
| cvxbson | ||
| </a> | ||
| <div role="search"> | ||
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> | ||
| <input type="text" name="q" placeholder="Search docs" aria-label="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="../../license.html">License</a></li> | ||
| </ul> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../../autoapi/index.html">API Reference</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">cvxbson</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" aria-label="Home"></a></li> | ||
| <li class="breadcrumb-item"><a href="../index.html">Module code</a></li> | ||
| <li class="breadcrumb-item active">data.render</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>Source code for data.render</h1><div class="highlight"><pre> | ||
| <span></span><span class="c1"># Copyright 2023 Stanford University Convex Optimization Group</span> | ||
| <span class="c1">#</span> | ||
| <span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span> | ||
| <span class="c1"># you may not use this file except in compliance with the License.</span> | ||
| <span class="c1"># You may obtain a copy of the License at</span> | ||
| <span class="c1">#</span> | ||
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> | ||
| <span class="c1">#</span> | ||
| <span class="c1"># Unless required by applicable law or agreed to in writing, software</span> | ||
| <span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span> | ||
| <span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> | ||
| <span class="c1"># See the License for the specific language governing permissions and</span> | ||
| <span class="c1"># limitations under the License.</span> | ||
| <span class="sd">"""Create a dataclass from a template"""</span> | ||
| <span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span> | ||
|
|
||
| <span class="kn">from</span> <span class="nn">jinja2</span> <span class="kn">import</span> <span class="n">Template</span> | ||
|
|
||
|
|
||
| <div class="viewcode-block" id="render"> | ||
| <a class="viewcode-back" href="../../autoapi/data/render/index.html#data.render.render">[docs]</a> | ||
| <span class="k">def</span> <span class="nf">render</span><span class="p">(</span><span class="n">names</span><span class="p">,</span> <span class="n">strategy</span><span class="p">):</span> | ||
| <span class="c1"># gain this dictionary through reflection</span> | ||
| <span class="c1"># every table has a shortname, e.g. prices and a longer descriptive name</span> | ||
| <span class="c1"># we use the shortname to name the variable refering to the code</span> | ||
| <span class="c1"># names = {"A": "AAA", "B": "BBB", "C": "CCC"}</span> | ||
| <span class="n">path</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span><span class="o">.</span><span class="n">parent</span> | ||
|
|
||
| <span class="c1"># open the template</span> | ||
| <span class="n">template</span> <span class="o">=</span> <span class="n">Template</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="n">path</span> <span class="o">/</span> <span class="s2">"data_api.py.jinja2"</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">())</span> | ||
|
|
||
| <span class="c1"># we copy & paste the new class into a new file</span> | ||
| <span class="k">return</span> <span class="n">template</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="n">names</span><span class="o">=</span><span class="n">names</span><span class="p">,</span> <span class="n">strategy</span><span class="o">=</span><span class="n">strategy</span><span class="p">)</span></div> | ||
|
|
||
| </pre></div> | ||
|
|
||
| </div> | ||
| </div> | ||
| <footer> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p>© Copyright .</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> |
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
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,15 @@ | ||
| :py:mod:`data` | ||
| ============== | ||
|
|
||
| .. py:module:: data | ||
| Submodules | ||
| ---------- | ||
| .. toctree:: | ||
| :titlesonly: | ||
| :maxdepth: 1 | ||
|
|
||
| render/index.rst | ||
|
|
||
|
|
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,27 @@ | ||
| :py:mod:`data.render` | ||
| ===================== | ||
|
|
||
| .. py:module:: data.render | ||
| .. autoapi-nested-parse:: | ||
|
|
||
| Create a dataclass from a template | ||
|
|
||
|
|
||
|
|
||
| Module Contents | ||
| --------------- | ||
|
|
||
|
|
||
| Functions | ||
| ~~~~~~~~~ | ||
|
|
||
| .. autoapisummary:: | ||
|
|
||
| data.render.render | ||
|
|
||
|
|
||
|
|
||
| .. py:function:: render(names, strategy) | ||
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
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
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
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
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
Oops, something went wrong.