Skip to content

Commit 9d796d3

Browse files
actions-useractions-user
committed
Update documentation
1 parent 6342084 commit 9d796d3

128 files changed

Lines changed: 5820 additions & 12558 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎JOSS/paper.html‎

Lines changed: 87 additions & 59 deletions
Large diffs are not rendered by default.

‎_modules/gym_electric_motor/callbacks.html‎

Lines changed: 30 additions & 47 deletions
Large diffs are not rendered by default.

‎_modules/gym_electric_motor/constraints.html‎

Lines changed: 36 additions & 53 deletions
Large diffs are not rendered by default.

‎_modules/gym_electric_motor/core.html‎

Lines changed: 112 additions & 222 deletions
Large diffs are not rendered by default.

‎_modules/gym_electric_motor/envs/gym_dcm/extex_dc_motor_env/cont_cc_extex_dc_env.html‎

Lines changed: 31 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
2-
31
<!DOCTYPE html>
4-
<html class="writer-html5" lang="en" data-content_root="../../../../../">
2+
<html class="writer-html5" lang="en" >
53
<head>
64
<meta charset="utf-8" />
75
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
86
<title>gym_electric_motor.envs.gym_dcm.extex_dc_motor_env.cont_cc_extex_dc_env &mdash; gym-electric-motor 2021 documentation</title>
9-
<link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=03e43079" />
10-
<link rel="stylesheet" type="text/css" href="../../../../../_static/css/theme.css?v=e59714d7" />
11-
7+
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
8+
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
9+
<!--[if lt IE 9]>
10+
<script src="../../../../../_static/js/html5shiv.min.js"></script>
11+
<![endif]-->
1212

13-
<script src="../../../../../_static/jquery.js?v=5d32c60e"></script>
14-
<script src="../../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
15-
<script src="../../../../../_static/documentation_options.js?v=37e646e6"></script>
16-
<script src="../../../../../_static/doctools.js?v=9a2dae69"></script>
17-
<script src="../../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
13+
<script src="../../../../../_static/jquery.js"></script>
14+
<script src="../../../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
15+
<script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script>
16+
<script src="../../../../../_static/doctools.js"></script>
17+
<script src="../../../../../_static/sphinx_highlight.js"></script>
1818
<script src="../../../../../_static/js/theme.js"></script>
1919
<link rel="index" title="Index" href="../../../../../genindex.html" />
2020
<link rel="search" title="Search" href="../../../../../search.html" />
@@ -41,25 +41,20 @@
4141
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
4242
<p class="caption" role="heading"><span class="caption-text">Gym Electric Motor Readme:</span></p>
4343
<ul>
44-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/readme.html">Readme File</a></li>
44+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/readme.html">Readme File</a></li>
4545
</ul>
4646
<p class="caption" role="heading"><span class="caption-text">gym-electric-motor Contents:</span></p>
4747
<ul>
48-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/environments/environment.html">Environments</a></li>
49-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/reference_generators/reference_generator.html">Reference Generators</a></li>
50-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/reward_functions/reward_function.html">Reward Functions</a></li>
51-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/physical_systems/physical_system.html">Physical Systems</a></li>
52-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/visualizations/visualization.html">Visualization</a></li>
53-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/constraint_monitor.html">Constraint Monitor</a></li>
54-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/core.html">Core</a></li>
55-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/utils.html">Utils</a></li>
56-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/callbacks.html">Callbacks</a></li>
57-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gem/random_component.html">Random Component</a></li>
58-
</ul>
59-
<p class="caption" role="heading"><span class="caption-text">GEM-Control Contents:</span></p>
60-
<ul>
61-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gc/usage_guide/usage_guides.html">Usage Guides</a></li>
62-
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts_gc/api_documentation/gem_control.html">GEM Control API Documentation</a></li>
48+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/environments/environment.html">Environments</a></li>
49+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/reference_generators/reference_generator.html">Reference Generators</a></li>
50+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/reward_functions/reward_function.html">Reward Functions</a></li>
51+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/physical_systems/physical_system.html">Physical Systems</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/visualizations/visualization.html">Visualization</a></li>
53+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/constraint_monitor.html">Constraint Monitor</a></li>
54+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/core.html">Core</a></li>
55+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/utils.html">Utils</a></li>
56+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/callbacks.html">Callbacks</a></li>
57+
<li class="toctree-l1"><a class="reference internal" href="../../../../../parts/random_component.html">Random Component</a></li>
6358
</ul>
6459

6560
</div>
@@ -87,26 +82,24 @@
8782
<div itemprop="articleBody">
8883

8984
<h1>Source code for gym_electric_motor.envs.gym_dcm.extex_dc_motor_env.cont_cc_extex_dc_env</h1><div class="highlight"><pre>
90-
<span></span><span class="kn">from</span><span class="w"> </span><span class="nn">gym_electric_motor</span><span class="w"> </span><span class="kn">import</span> <span class="n">physical_systems</span> <span class="k">as</span> <span class="n">ps</span>
91-
<span class="kn">from</span><span class="w"> </span><span class="nn">gym_electric_motor.core</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
85+
<span></span><span class="kn">from</span> <span class="nn">gym_electric_motor</span> <span class="kn">import</span> <span class="n">physical_systems</span> <span class="k">as</span> <span class="n">ps</span>
86+
<span class="kn">from</span> <span class="nn">gym_electric_motor.core</span> <span class="kn">import</span> <span class="p">(</span>
9287
<span class="n">ElectricMotorEnvironment</span><span class="p">,</span>
9388
<span class="n">ElectricMotorVisualization</span><span class="p">,</span>
9489
<span class="n">ReferenceGenerator</span><span class="p">,</span>
9590
<span class="n">RewardFunction</span><span class="p">,</span>
9691
<span class="p">)</span>
97-
<span class="kn">from</span><span class="w"> </span><span class="nn">gym_electric_motor.physical_systems.physical_systems</span><span class="w"> </span><span class="kn">import</span> <span class="n">DcMotorSystem</span>
98-
<span class="kn">from</span><span class="w"> </span><span class="nn">gym_electric_motor.reference_generators</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
92+
<span class="kn">from</span> <span class="nn">gym_electric_motor.physical_systems.physical_systems</span> <span class="kn">import</span> <span class="n">DcMotorSystem</span>
93+
<span class="kn">from</span> <span class="nn">gym_electric_motor.reference_generators</span> <span class="kn">import</span> <span class="p">(</span>
9994
<span class="n">MultipleReferenceGenerator</span><span class="p">,</span>
10095
<span class="n">WienerProcessReferenceGenerator</span><span class="p">,</span>
10196
<span class="p">)</span>
102-
<span class="kn">from</span><span class="w"> </span><span class="nn">gym_electric_motor.reward_functions</span><span class="w"> </span><span class="kn">import</span> <span class="n">WeightedSumOfErrors</span>
103-
<span class="kn">from</span><span class="w"> </span><span class="nn">gym_electric_motor.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">initialize</span>
104-
<span class="kn">from</span><span class="w"> </span><span class="nn">gym_electric_motor.visualization</span><span class="w"> </span><span class="kn">import</span> <span class="n">MotorDashboard</span>
97+
<span class="kn">from</span> <span class="nn">gym_electric_motor.reward_functions</span> <span class="kn">import</span> <span class="n">WeightedSumOfErrors</span>
98+
<span class="kn">from</span> <span class="nn">gym_electric_motor.utils</span> <span class="kn">import</span> <span class="n">initialize</span>
99+
<span class="kn">from</span> <span class="nn">gym_electric_motor.visualization</span> <span class="kn">import</span> <span class="n">MotorDashboard</span>
105100

106101

107-
<div class="viewcode-block" id="ContCurrentControlDcExternallyExcitedMotorEnv">
108-
<a class="viewcode-back" href="../../../../../parts_gem/environments/extex_dc/cont_cc_extex.html#gym_electric_motor.envs.ContCurrentControlDcExternallyExcitedMotorEnv">[docs]</a>
109-
<span class="k">class</span><span class="w"> </span><span class="nc">ContCurrentControlDcExternallyExcitedMotorEnv</span><span class="p">(</span><span class="n">ElectricMotorEnvironment</span><span class="p">):</span>
102+
<div class="viewcode-block" id="ContCurrentControlDcExternallyExcitedMotorEnv"><a class="viewcode-back" href="../../../../../parts/environments/extex_dc/cont_cc_extex.html#gym_electric_motor.envs.ContCurrentControlDcExternallyExcitedMotorEnv">[docs]</a><span class="k">class</span> <span class="nc">ContCurrentControlDcExternallyExcitedMotorEnv</span><span class="p">(</span><span class="n">ElectricMotorEnvironment</span><span class="p">):</span>
110103
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
111104
<span class="sd"> Description:</span>
112105
<span class="sd"> Environment to simulate a continuous control set current controlled externally excited DC Motor</span>
@@ -181,7 +174,7 @@ <h1>Source code for gym_electric_motor.envs.gym_dcm.extex_dc_motor_env.cont_cc_e
181174
<span class="sd"> &gt;&gt;&gt; (state, reference), reward, terminated, truncated, _ = env.step(env.action_space.sample())</span>
182175
<span class="sd"> &quot;&quot;&quot;</span>
183176

184-
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
177+
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
185178
<span class="bp">self</span><span class="p">,</span>
186179
<span class="n">supply</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
187180
<span class="n">converter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
@@ -292,7 +285,6 @@ <h1>Source code for gym_electric_motor.envs.gym_dcm.extex_dc_motor_env.cont_cc_e
292285
<span class="n">physical_system_wrappers</span><span class="o">=</span><span class="n">physical_system_wrappers</span><span class="p">,</span>
293286
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
294287
<span class="p">)</span></div>
295-
296288
</pre></div>
297289

298290
</div>

0 commit comments

Comments
 (0)