Tutorials

Users introduced to eMach for the first time can find it daunting to work with. The module has 3 sub-modules, each of which can work as standalone modules by themselves or can be interfaced with one another to get a neat implementation of what the overarching goal of the repository is – electric machine optimization.

The goal of the tutorials section is to help users understand the code base one layer at a time, and gradually move to problems of increasing difficulty with each example. First, tutorials for individual submodules are provided after which examples involving interfaces between multiple eMach functions are discussed. At the end of each tutorial, users are expected to understand how to use the different functionalities of eMach and understand what is happening under the hood to a certain extent as well. All tutorials have been written in a manner that assumes users treat the eMach repo as a Python package and import into their own custom scripts for using its functionalities.

Module	Tutorial Name	Goal
mach_cad	Making an Electric Machine using eMach	Familarize with mach_cad classes and capabilities
mach_eval	Analytical Machine Design Tutorial	Familarize with mach_eval classes and protocols
	BSPM Evaluation Tutorial	Multi-physics evaluation of BSPM designs
mach_opt	Ractangle Optimization Tutorial	Run a basic optimization using mach_opt
	Analytical Machine Optimization Tutorial	Use mach_eval and mach_opt together for optimization
	BSPM Optimization Tutorial	Run multi-objective, multi-physics BSPM optimization