Severson-Group / eMach

Open Source Machine Modeling and Optimization Framework. X Mach Speed.

https://emach.readthedocs.io

BSD 3-Clause "New" or "Revised" License

18 stars 3 forks source link

Add Machine and Operating Point Sections to Code and Documentation Files #344

Open dmnewman3 opened 6 months ago

dmnewman3 commented 6 months ago

Issue

Address issue #312

Summary

This PR does the following:

adds machine and operating point sections to documentation.rst file
adds machine and operating point sections to code.rst file

close #312

dmnewman3 commented 5 months ago

@wchan29 @noguchi-takahiro @elsevers Can one of you review this PR?

dmnewman3 commented 4 months ago

Thank you for updating the eMach documents, @dmnewman3. This looks useful. I personally prefer that the 2.2.1 Machine Class section outlines 1. Requirements to fully define machine and 2. Code comments on user input, which is similar manner as 2.2.2. If you accept this, could you consider to revise the article? I also want to propose some ideas below;

Thanks @noguchi-takahiro, I have implemented these and re-written the section in question. Please let me know what you think.