Repository navigation
Write a simple documentation with examples #67
Description
Write a simple documentation with examples to use Honza's group and give feedback.
Including:
- How to compute a winding layout for a given (phases, slots, pole_pairs, coil pitch), with a worked example
- give the meanings of outputs
- How it relates to coil_pith/belt_offset
Metadata
Metadata
Assignees
Labels
No labels
Activity
haitao-ZCU commentedon Oct 21, 2026
@saxik13
Hi Honza, I have written a WINDING.md covering how to use compute_winding_layout (with two worked examples, 3f_36s and 5f_40s machines), the meanings of the outputs, double layer windings, and the relation to coil_pitch/belt_offset.
Could you take a look when you are free and let me know if anything is missing or not clear? If it looks good, I'll propose a PR to merge it into main.
The link of the WINDING.md is
https://github.com/AI-RICE/MachineDesign/blob/67-write-a-simple-documentation-with-examples/machine_design/generic/WINDING.md
saxik13 commentedon Oct 22, 2026
Hi Haitao,
I think the WINDING.md is understandable and OK.
Remark regarding the coil pitch. We could let it empty (e.g. with None value) - then it could be chosen automatically where the "optimum" is:
coil_pitch = (2m-1)/(2m)(Q/(2p))
Q/(2p) is the full pitch, and the ratio (2m-1)/(2*m) is based on the suppression of higher harmonics.
It must be an integer, and for layers==1 it is an odd number.
Practically, usually, the closest higher value is chosen.
Therefore, for the example phases=3, slots=36, pole_pairs=2, the optimum coil pitch is 7.5, but the final value is 9, not 7.
It is not necessary to include now, but it could help in the future for an automatic winding design.
haitao-ZCU commentedon Oct 22, 2026
@saxik13
Hi Honza. Thanks for your feedback.
I think I need to fix the bug in automatic selection of coil_pitch.
For phases=3, slots=36, pole_pairs=2, the optimum coil pitch is 7.5, but the current code selects 7 instead of 9. According to your suggestion (Practically, usually, the closest higher value is chosen.), it should choose the next higher odd number 9.
I also have a question about double layer windings. For example, phases=4, slots=96, pole_pairs=5, and layers=2, the optimum coil pitch is 8.4, and the current code selects 8.
You mentioned that "Practically, usually, the closest higher value is chosen.". Does this suggestion also apply to double layer windings? I mean, in this case, should we select 9 instead of 8?
saxik13 commentedon Oct 22, 2026
It is a question of technology and manufacturers' practice. We can leave it as it is and modify it in the future with realistic examples...