Skip to content

Commit adc8f39

Browse files
mounica3003mounica3003
committed
fixing block errors
1 parent 12d4ca3 commit adc8f39

4 files changed

Lines changed: 172 additions & 104 deletions

File tree

‎docs/parts_gc/api_documentation/block_diagrams/block_diagrams.rst‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
Block Diagrams
22
==============
33

4-
.. automodule:: gem_controllers.block_diagrams.block_diagram.build_block_diagram
5-
:members: build_block_diagram,get_stages
6-
:undoc-members:
7-
:member-order: groupwise
4+
.. autofunction:: gem_controllers.block_diagrams.block_diagram.build_block_diagram
5+
6+
.. autofunction:: gem_controllers.block_diagrams.block_diagram.get_stages

‎docs/parts_gc/api_documentation/stages/operation_point_selection/operation_point_selection.rst‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,15 @@ Operation Point Selection
55
:maxdepth: 1
66

77
permex_dc_ops
8-
extex_dc_ops
8+
exter_dc_ops
99
series_dc_ops
1010
shunt_dc_ops
1111
foc_ops
1212
pmsm_ops
1313
eesm_ops
1414
scim_ops
1515

16-
.. currentmodule:: gem_controllers.stages.operation_point_selection.operation_point_selection
17-
18-
.. autoclass:: OperationPointSelection
16+
.. autoclass:: gem_controllers.stages.operation_point_selection.operation_point_selection.OperationPointSelection
1917
:members:
2018
:undoc-members:
2119
:inherited-members:

‎docs/parts_gem/core.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ Core
33

44
.. figure:: ../plots/CoreClasses.svg
55

6-
.. automodule:: gym_electric_motor.core
6+
.. currentmodule:: gym_electric_motor.core
77
:members:
88
:exclude-members: ConstraintMonitor, ElectricMotorEnvironment

‎docs/parts_gem/environments/environment.rst‎

Lines changed: 166 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -11,101 +11,172 @@ In general, all environment-ids are structured as follows:
1111
- The ``MotorType`` is in ``{PermExDc / ExtExDc / SeriesDc / ShuntDc / PMSM / SynRM / / EESM / DFIM / SCIM / SIXPMSM }``
1212

1313

14-
=================================================================== ==============================
15-
Environment environment-id
16-
=================================================================== ==============================
17-
**Permanently Excited DC Motor Environments**
18-
19-
Discrete Torque Control Permanently Excited DC Motor Environment ``'Finite-TC-PermExDc-v0'``
20-
Continuous Torque Control Permanently Excited DC Motor Environment ``'Cont-TC-PermExDc-v0'``
21-
Discrete Speed Control Permanently Excited DC Motor Environment ``'Finite-SC-PermExDc-v0'``
22-
Continuous Speed Control Permanently Excited DC Motor Environment ``'Cont-SC-PermExDc-v0'``
23-
Discrete Current Control Permanently Excited DC Motor Environment ``'Finite-CC-PermExDc-v0'``
24-
Continuous Current Control Permanently Excited DC Motor Environment ``'Cont-CC-PermExDc-v0'``
25-
26-
**Externally Excited DC Motor Environments**
27-
28-
Discrete Torque Control Externally Excited DC Motor Environment ``'Finite-TC-ExtExDc-v0'``
29-
Continuous Torque Control Externally Excited DC Motor Environment ``'Cont-TC-ExtExDc-v0'``
30-
Discrete Speed Control Externally Excited DC Motor Environment ``'Finite-SC-ExtExDc-v0'``
31-
Continuous Speed Control Externally Excited DC Motor Environment ``'Cont-SC-ExtExDc-v0'``
32-
Discrete Current Control Externally Excited DC Motor Environment ``'Finite-CC-ExtExDc-v0'``
33-
Continuous Current Control Externally Excited DC Motor Environment ``'Cont-CC-ExtExDc-v0'``
34-
35-
**Series DC Motor Environments**
36-
37-
Discrete Torque Control Series DC Motor Environment ``'Finite-TC-SeriesDc-v0'``
38-
Discrete Torque Control Series DC Motor Environment ``'Cont-TC-SeriesDc-v0'``
39-
Discrete Speed Control Series DC Motor Environment ``'Finite-SC-SeriesDc-v0'``
40-
Continuous Speed Control Series DC Motor Environment ``'Cont-SC-SeriesDc-v0'``
41-
Discrete Current Control Series DC Motor Environment ``'Finite-CC-SeriesDc-v0'``
42-
Continuous Current Control Series DC Motor Environment ``'Cont-CC-SeriesDc-v0'``
43-
44-
**Shunt DC Motor Environments**
45-
46-
Discrete Torque Control Shunt DC Motor Environment ``'Finite-TC-ShuntDc-v0'``
47-
Continuous Torque Control Shunt DC Motor Environment ``'Cont-TC-ShuntDc-v0'``
48-
Discrete Speed Control Shunt DC Motor Environment ``'Finite-SC-ShuntDc-v0'``
49-
Continuous Speed Control Shunt DC Motor Environment ``'Cont-SC-ShuntDc-v0'``
50-
Discrete Current Control Shunt DC Motor Environment ``'Finite-CC-ShuntDc-v0'``
51-
Continuous Current Control Shunt DC Motor Environment ``'Cont-CC-ShuntDc-v0'``
52-
53-
**Permanent Magnet Synchronous Motor (PMSM) Environments**
54-
55-
Finite Torque Control PMSM Environment ``'Finite-TC-PMSM-v0'``
56-
Torque Control PMSM Environment ``'Cont-TC-PMSM-v0'``
57-
Finite Speed Control PMSM Environment ``'Finite-SC-PMSM-v0'``
58-
Speed Control PMSM Environment ``'Cont-SC-PMSM-v0'``
59-
Finite Current Control PMSM Environment ``'Finite-CC-PMSM-v0'``
60-
Current Control PMSM Environment ``'Cont-CC-PMSM-v0'``
61-
62-
63-
**Externally Excited Synchronous Motor (EESM) Environments**
64-
65-
Finite Torque Control EESM Environment ``'Finite-TC-EESM-v0'``
66-
Torque Control EESM Environment ``'Cont-TC-EESM-v0'``
67-
Finite Speed Control EESM Environment ``'Finite-SC-EESM-v0'``
68-
Speed Control EESM Environment ``'Cont-SC-EESM-v0'``
69-
Finite Current Control EESM Environment ``'Finite-CC-EESM-v0'``
70-
Current Control EESM Environment ``'Cont-CC-EESM-v0'``
71-
72-
**Synchronous Reluctance Motor (SynRM) Environments**
73-
74-
Finite Torque Control SynRM Environment ``'Finite-TC-SynRM-v0'``
75-
Torque Control SynRM Environment ``'Cont-TC-SynRM-v0'``
76-
Finite Speed Control SynRM Environment ``'Finite-SC-SynRM-v0'``
77-
Speed Control SynRM Environment ``'Cont-SC-SynRM-v0'``
78-
Finite Current Control SynRM Environment ``'Finite-CC-SynRM-v0'``
79-
Current Control SynRM Environment ``'Cont-CC-SynRM-v0'``
80-
81-
**Squirrel Cage Induction Motor (SCIM) Environments**
82-
83-
Finite Torque Control SCIM Environment ``'Finite-TC-SCIM-v0'``
84-
Torque Control SCIM Environment ``'Cont-TC-SCIM-v0'``
85-
Finite Speed Control SCIM Environment ``'Finite-SC-SCIM-v0'``
86-
Speed Control SCIM Environment ``'Cont-SC-SCIM-v0'``
87-
Finite Current Control SCIM Environment ``'Finite-CC-SCIM-v0'``
88-
Current Control SCIM Environment ``'Cont-CC-SCIM-v0'``
89-
90-
**Doubly Fed Induction Motor (DFIM) Environments**
91-
92-
Finite Torque Control DFIM Environment ``'Finite-TC-DFIM-v0'``
93-
Torque Control DFIM Environment ``'Cont-TC-DFIM-v0'``
94-
Finite Speed Control DFIM Environment ``'Finite-SC-DFIM-v0'``
95-
Speed Control DFIM Environment ``'Cont-SC-DFIM-v0'``
96-
Finite Current Control DFIM Environment ``'Finite-CC-DFIM-v0'``
97-
Current Control DFIM Environment ``'Cont-CC-DFIM-v0'``
98-
99-
**Six Phase Permanent Magnet Synchronous Motor (SIXPMSM) Environments**
100-
101-
Finite Torque Control SIXPMSM Environment ``'Finite-TC-SIXPMSM-v0'``
102-
Torque Control SIXPMSM Environment ``'Cont-TC-SIXPMSM-v0'``
103-
Finite Speed Control SIXPMSM Environment ``'Finite-SC-SIXPMSM-v0'``
104-
Speed Control SIXPMSM Environment ``'Cont-SC-SIXPMSM-v0'``
105-
Finite Current Control SIXPMSM Environment ``'Finite-CC-SIXPMSM-v0'``
106-
Current Control SIXPMSM Environment ``'Cont-CC-SIXPMSM-v0'``
107-
108-
=================================================================== ==============================
14+
.. list-table::
15+
:header-rows: 1
16+
:widths: 65 35
17+
18+
* - Environment
19+
- environment-id
20+
21+
* - **Permanently Excited DC Motor Environments**
22+
-
23+
24+
* - Discrete Torque Control Permanently Excited DC Motor Environment
25+
- ``'Finite-TC-PermExDc-v0'``
26+
* - Continuous Torque Control Permanently Excited DC Motor Environment
27+
- ``'Cont-TC-PermExDc-v0'``
28+
* - Discrete Speed Control Permanently Excited DC Motor Environment
29+
- ``'Finite-SC-PermExDc-v0'``
30+
* - Continuous Speed Control Permanently Excited DC Motor Environment
31+
- ``'Cont-SC-PermExDc-v0'``
32+
* - Discrete Current Control Permanently Excited DC Motor Environment
33+
- ``'Finite-CC-PermExDc-v0'``
34+
* - Continuous Current Control Permanently Excited DC Motor Environment
35+
- ``'Cont-CC-PermExDc-v0'``
36+
37+
* - **Externally Excited DC Motor Environments**
38+
-
39+
40+
* - Discrete Torque Control Externally Excited DC Motor Environment
41+
- ``'Finite-TC-ExtExDc-v0'``
42+
* - Continuous Torque Control Externally Excited DC Motor Environment
43+
- ``'Cont-TC-ExtExDc-v0'``
44+
* - Discrete Speed Control Externally Excited DC Motor Environment
45+
- ``'Finite-SC-ExtExDc-v0'``
46+
* - Continuous Speed Control Externally Excited DC Motor Environment
47+
- ``'Cont-SC-ExtExDc-v0'``
48+
* - Discrete Current Control Externally Excited DC Motor Environment
49+
- ``'Finite-CC-ExtExDc-v0'``
50+
* - Continuous Current Control Externally Excited DC Motor Environment
51+
- ``'Cont-CC-ExtExDc-v0'``
52+
53+
* - **Series DC Motor Environments**
54+
-
55+
56+
* - Discrete Torque Control Series DC Motor Environment
57+
- ``'Finite-TC-SeriesDc-v0'``
58+
* - Continuous Torque Control Series DC Motor Environment
59+
- ``'Cont-TC-SeriesDc-v0'``
60+
* - Discrete Speed Control Series DC Motor Environment
61+
- ``'Finite-SC-SeriesDc-v0'``
62+
* - Continuous Speed Control Series DC Motor Environment
63+
- ``'Cont-SC-SeriesDc-v0'``
64+
* - Discrete Current Control Series DC Motor Environment
65+
- ``'Finite-CC-SeriesDc-v0'``
66+
* - Continuous Current Control Series DC Motor Environment
67+
- ``'Cont-CC-SeriesDc-v0'``
68+
69+
* - **Shunt DC Motor Environments**
70+
-
71+
72+
* - Discrete Torque Control Shunt DC Motor Environment
73+
- ``'Finite-TC-ShuntDc-v0'``
74+
* - Continuous Torque Control Shunt DC Motor Environment
75+
- ``'Cont-TC-ShuntDc-v0'``
76+
* - Discrete Speed Control Shunt DC Motor Environment
77+
- ``'Finite-SC-ShuntDc-v0'``
78+
* - Continuous Speed Control Shunt DC Motor Environment
79+
- ``'Cont-SC-ShuntDc-v0'``
80+
* - Discrete Current Control Shunt DC Motor Environment
81+
- ``'Finite-CC-ShuntDc-v0'``
82+
* - Continuous Current Control Shunt DC Motor Environment
83+
- ``'Cont-CC-ShuntDc-v0'``
84+
85+
* - **Permanent Magnet Synchronous Motor (PMSM) Environments**
86+
-
87+
88+
* - Finite Torque Control PMSM Environment
89+
- ``'Finite-TC-PMSM-v0'``
90+
* - Torque Control PMSM Environment
91+
- ``'Cont-TC-PMSM-v0'``
92+
* - Finite Speed Control PMSM Environment
93+
- ``'Finite-SC-PMSM-v0'``
94+
* - Speed Control PMSM Environment
95+
- ``'Cont-SC-PMSM-v0'``
96+
* - Finite Current Control PMSM Environment
97+
- ``'Finite-CC-PMSM-v0'``
98+
* - Current Control PMSM Environment
99+
- ``'Cont-CC-PMSM-v0'``
100+
101+
* - **Externally Excited Synchronous Motor (EESM) Environments**
102+
-
103+
104+
* - Finite Torque Control EESM Environment
105+
- ``'Finite-TC-EESM-v0'``
106+
* - Torque Control EESM Environment
107+
- ``'Cont-TC-EESM-v0'``
108+
* - Finite Speed Control EESM Environment
109+
- ``'Finite-SC-EESM-v0'``
110+
* - Speed Control EESM Environment
111+
- ``'Cont-SC-EESM-v0'``
112+
* - Finite Current Control EESM Environment
113+
- ``'Finite-CC-EESM-v0'``
114+
* - Current Control EESM Environment
115+
- ``'Cont-CC-EESM-v0'``
116+
117+
* - **Synchronous Reluctance Motor (SynRM) Environments**
118+
-
119+
120+
* - Finite Torque Control SynRM Environment
121+
- ``'Finite-TC-SynRM-v0'``
122+
* - Torque Control SynRM Environment
123+
- ``'Cont-TC-SynRM-v0'``
124+
* - Finite Speed Control SynRM Environment
125+
- ``'Finite-SC-SynRM-v0'``
126+
* - Speed Control SynRM Environment
127+
- ``'Cont-SC-SynRM-v0'``
128+
* - Finite Current Control SynRM Environment
129+
- ``'Finite-CC-SynRM-v0'``
130+
* - Current Control SynRM Environment
131+
- ``'Cont-CC-SynRM-v0'``
132+
133+
* - **Squirrel Cage Induction Motor (SCIM) Environments**
134+
-
135+
136+
* - Finite Torque Control SCIM Environment
137+
- ``'Finite-TC-SCIM-v0'``
138+
* - Torque Control SCIM Environment
139+
- ``'Cont-TC-SCIM-v0'``
140+
* - Finite Speed Control SCIM Environment
141+
- ``'Finite-SC-SCIM-v0'``
142+
* - Speed Control SCIM Environment
143+
- ``'Cont-SC-SCIM-v0'``
144+
* - Finite Current Control SCIM Environment
145+
- ``'Finite-CC-SCIM-v0'``
146+
* - Current Control SCIM Environment
147+
- ``'Cont-CC-SCIM-v0'``
148+
149+
* - **Doubly Fed Induction Motor (DFIM) Environments**
150+
-
151+
152+
* - Finite Torque Control DFIM Environment
153+
- ``'Finite-TC-DFIM-v0'``
154+
* - Torque Control DFIM Environment
155+
- ``'Cont-TC-DFIM-v0'``
156+
* - Finite Speed Control DFIM Environment
157+
- ``'Finite-SC-DFIM-v0'``
158+
* - Speed Control DFIM Environment
159+
- ``'Cont-SC-DFIM-v0'``
160+
* - Finite Current Control DFIM Environment
161+
- ``'Finite-CC-DFIM-v0'``
162+
* - Current Control DFIM Environment
163+
- ``'Cont-CC-DFIM-v0'``
164+
165+
* - **Six Phase PMSM (SIXPMSM) Environments**
166+
-
167+
168+
* - Finite Torque Control SIXPMSM Environment
169+
- ``'Finite-TC-SIXPMSM-v0'``
170+
* - Torque Control SIXPMSM Environment
171+
- ``'Cont-TC-SIXPMSM-v0'``
172+
* - Finite Speed Control SIXPMSM Environment
173+
- ``'Finite-SC-SIXPMSM-v0'``
174+
* - Speed Control SIXPMSM Environment
175+
- ``'Cont-SC-SIXPMSM-v0'``
176+
* - Finite Current Control SIXPMSM Environment
177+
- ``'Finite-CC-SIXPMSM-v0'``
178+
* - Current Control SIXPMSM Environment
179+
- ``'Cont-CC-SIXPMSM-v0'``
109180

110181
.. toctree::
111182
:maxdepth: 3

0 commit comments

Comments
 (0)