Environments ############ On this page, all environments with their environment-id are listed. In general, all environment-ids are structured as follows: ``ControlType-ControlTask-MotorType-v0`` - The ``ControlType`` is in ``{Finite / Cont}`` for finite control set and continuous control set action spaces - The ``ControlTask`` is in ``{TC / SC / CC}`` (Torque / Speed / Current Control) - The ``MotorType`` is in ``{PermExDc / ExtExDc / SeriesDc / ShuntDc / PMSM / SynRM / / EESM / DFIM / SCIM }`` =================================================================== ============================== Environment environment-id =================================================================== ============================== **Permanently Excited DC Motor Environments** Discrete Torque Control Permanently Excited DC Motor Environment ``'Finite-TC-PermExDc-v0'`` Continuous Torque Control Permanently Excited DC Motor Environment ``'Cont-TC-PermExDc-v0'`` Discrete Speed Control Permanently Excited DC Motor Environment ``'Finite-SC-PermExDc-v0'`` Continuous Speed Control Permanently Excited DC Motor Environment ``'Cont-SC-PermExDc-v0'`` Discrete Current Control Permanently Excited DC Motor Environment ``'Finite-CC-PermExDc-v0'`` Continuous Current Control Permanently Excited DC Motor Environment ``'Cont-CC-PermExDc-v0'`` **Externally Excited DC Motor Environments** Discrete Torque Control Externally Excited DC Motor Environment ``'Finite-TC-ExtExDc-v0'`` Continuous Torque Control Externally Excited DC Motor Environment ``'Cont-TC-ExtExDc-v0'`` Discrete Speed Control Externally Excited DC Motor Environment ``'Finite-SC-ExtExDc-v0'`` Continuous Speed Control Externally Excited DC Motor Environment ``'Cont-SC-ExtExDc-v0'`` Discrete Current Control Externally Excited DC Motor Environment ``'Finite-CC-ExtExDc-v0'`` Continuous Current Control Externally Excited DC Motor Environment ``'Cont-CC-ExtExDc-v0'`` **Series DC Motor Environments** Discrete Torque Control Series DC Motor Environment ``'Finite-TC-SeriesDc-v0'`` Discrete Torque Control Series DC Motor Environment ``'Cont-TC-SeriesDc-v0'`` Discrete Speed Control Series DC Motor Environment ``'Finite-SC-SeriesDc-v0'`` Continuous Speed Control Series DC Motor Environment ``'Cont-SC-SeriesDc-v0'`` Discrete Current Control Series DC Motor Environment ``'Finite-CC-SeriesDc-v0'`` Continuous Current Control Series DC Motor Environment ``'Cont-CC-SeriesDc-v0'`` **Shunt DC Motor Environments** Discrete Torque Control Shunt DC Motor Environment ``'Finite-TC-ShuntDc-v0'`` Continuous Torque Control Shunt DC Motor Environment ``'Cont-TC-ShuntDc-v0'`` Discrete Speed Control Shunt DC Motor Environment ``'Finite-SC-ShuntDc-v0'`` Continuous Speed Control Shunt DC Motor Environment ``'Cont-SC-ShuntDc-v0'`` Discrete Current Control Shunt DC Motor Environment ``'Finite-CC-ShuntDc-v0'`` Continuous Current Control Shunt DC Motor Environment ``'Cont-CC-ShuntDc-v0'`` **Permanent Magnet Synchronous Motor (PMSM) Environments** Finite Torque Control PMSM Environment ``'Finite-TC-PMSM-v0'`` Torque Control PMSM Environment ``'Cont-TC-PMSM-v0'`` Finite Speed Control PMSM Environment ``'Finite-SC-PMSM-v0'`` Speed Control PMSM Environment ``'Cont-SC-PMSM-v0'`` Finite Current Control PMSM Environment ``'Finite-CC-PMSM-v0'`` Current Control PMSM Environment ``'Cont-CC-PMSM-v0'`` **Externally Excited Synchronous Motor (EESM) Environments** Finite Torque Control EESM Environment ``'Finite-TC-EESM-v0'`` Torque Control EESM Environment ``'Cont-TC-EESM-v0'`` Finite Speed Control EESM Environment ``'Finite-SC-EESM-v0'`` Speed Control EESM Environment ``'Cont-SC-EESM-v0'`` Finite Current Control EESM Environment ``'Finite-CC-EESM-v0'`` Current Control EESM Environment ``'Cont-CC-EESM-v0'`` **Synchronous Reluctance Motor (SynRM) Environments** Finite Torque Control SynRM Environment ``'Finite-TC-SynRM-v0'`` Torque Control SynRM Environment ``'Cont-TC-SynRM-v0'`` Finite Speed Control SynRM Environment ``'Finite-SC-SynRM-v0'`` Speed Control SynRM Environment ``'Cont-SC-SynRM-v0'`` Finite Current Control SynRM Environment ``'Finite-CC-SynRM-v0'`` Current Control SynRM Environment ``'Cont-CC-SynRM-v0'`` **Squirrel Cage Induction Motor (SCIM) Environments** Finite Torque Control SCIM Environment ``'Finite-TC-SCIM-v0'`` Torque Control SCIM Environment ``'Cont-TC-SCIM-v0'`` Finite Speed Control SCIM Environment ``'Finite-SC-SCIM-v0'`` Speed Control SCIM Environment ``'Cont-SC-SCIM-v0'`` Finite Current Control SCIM Environment ``'Finite-CC-SCIM-v0'`` Current Control SCIM Environment ``'Cont-CC-SCIM-v0'`` **Doubly Fed Induction Motor (DFIM) Environments** Finite Torque Control DFIM Environment ``'Finite-TC-DFIM-v0'`` Torque Control DFIM Environment ``'Cont-TC-DFIM-v0'`` Finite Speed Control DFIM Environment ``'Finite-SC-DFIM-v0'`` Speed Control DFIM Environment ``'Cont-SC-DFIM-v0'`` Finite Current Control DFIM Environment ``'Finite-CC-DFIM-v0'`` Current Control DFIM Environment ``'Cont-CC-DFIM-v0'`` =================================================================== ============================== .. toctree:: :maxdepth: 3 :caption: Motor Environments: :glob: permex_dc/permex_dc_envs extex_dc/extex_dc_envs series_dc/series_dc_envs shunt_dc/shunt_dc_envs pmsm/pmsm_envs eesm/eesm_envs synrm/synrm_envs scim/scim_envs dfim/dfim_envs Electric Motor Base Environment ''''''''''''''''''''''''''''''' .. automodule:: gym_electric_motor.core .. figure:: ../../plots/TopLevelStructure.svg .. autoclass:: gym_electric_motor.core.ElectricMotorEnvironment :members: