.. figure:: images/eMach.svg
   :alt: Trial1 
   :align: center
   :width: 300 


Welcome to eMach
=======================================================
``eMach`` is a open-source electric machine modeling, evaluation, and optimization framework developed in Python. ``eMach`` has 3 
distinct submodules, ``mach_cad``,  ``mach_eval``, and ``mach_opt``, all 3 of which work in tandem to enable the implementation of
modular solutions to electric machine optimization problems. Readers are adviced to go through the remainder the documentation 
links provided on the left to familiarize themselves with the repository.


.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Getting Started
   
   getting_started/pre_reqs
   getting_started/tutorials/index
   
.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: User Guide

   user_guide/index

.. toctree::
   :hidden:
   :maxdepth: 3
   :caption: Analyzers

   EM_analyzers/index
   mechanical_analyzers/index
   
.. toctree::
   :hidden:
   :maxdepth: 3
   :caption: Machine Designs

   machines/bspm/index
   machines/SynR/index

..
   Please!! Do not remove/modify the following INSERT comment. This allows a script to insert additional rst content into the index file.
   
..
   _INSERT


.. toctree::
   :hidden:
   :maxdepth: 2
   :numbered:
   :caption: Guidelines

   contribution
   code
   documentation
   maintainer
   
.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: Code

   auto_docs/modules


   
Indices
==================

* :ref:`genindex`
* :ref:`modindex`