Add autogen for AMDC article in control with AMDC folder - #151
Add autogen for AMDC article in control with AMDC folder#151Daehoon-Sung wants to merge 135 commits into
Conversation
Updated the document to focus on Simulink automatic code generation for AMDC, including calibration methods, procedures, and integration with AMDC.
Updated the steps for creating and configuring a Simulink model, including detailed instructions for setting up a reference model and generating C-code.
mhmokhtarabadi
left a comment
There was a problem hiding this comment.
This PR looks good to me now. @noguchi-takahiro, could you review this PR?
- Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? Yes
- Are all files named according to the appropriate naming convention, i.e., dash-case, camelCase, snake case? Yes
- Do all Markdown files follow the CONTRIBUTING article template? No contributing articles
- Do all links work in the material that the PR is adding? Yes
- Is the PR configured to close the correct issue(s)? Yes
- Did the PR fully address the
Approachsection of the issue(s) it is closing? Yes
|
Thank you @AwesomeTornado and @mhmokhtarabadi on making dark mode images. @AwesomeTornado I have a one question here. When I make a rendered page looking like website, I usually do |
|
@noguchi-takahiro Try running |
noguchi-takahiro
left a comment
There was a problem hiding this comment.
Thank you @Daehoon-Sung @mhmokhtarabadi @AwesomeTornado. Looks good to me.
This PR looks good to me now. @noguchi-takahiro, could you review this PR?
- Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? Yes
- Are all files named according to the appropriate naming convention, i.e., dash-case, camelCase, snake case? Yes
- Do all Markdown files follow the CONTRIBUTING article template? No contributing articles
- Do all links work in the material that the PR is adding? Yes
- Is the PR configured to close the correct issue(s)? Yes
- Did the PR fully address the
Approachsection of the issue(s) it is closing? Yes
@elsevers could you review this PR?
elsevers
left a comment
There was a problem hiding this comment.
Great, thanks @Daehoon-Sung and @noguchi-takahiro! This is getting close.
I have noted several feedback items inline below. A couple more things:
- Let's revise to use standard Mathworks terminology. The word "Autogen" is treated throughout both the article and tutorial as if that is a common, well known word. However, it is not --> for example, Google "matlab simulink autogen c code -- there is not a MATLAB page declaring "autogen" as a thing. I think it can be okay to use the term "Autogen," but it needs to be properly introduced.
- I like that we have links to various Mathworks supporting articles. However, we are missing a link (or a set of links) towards the start of the article to Mathworks explanation of autogenerating c code and their recommended best practices. We should tell readers that this article (and the tutorial) are our recommendation on how to translate those best practices to use in the AMDC environment.
f2f53d5
|
@elsevers I have addressed your feedback. Can you review this PR? |
|
@elsevers this PR is ready for you. |
elsevers
left a comment
There was a problem hiding this comment.
Thanks @noguchi-takahiro! I took a quick look and noted a couple more things -- listed inline below.
|
@elsevers I addressed your feedback and this is ready for review again. |
This is to close #143 to close #149 to close https://github.com/Severson-Group/AMDC-Examples/issues/6.
Notes
This comment might be useful to refer to how we came up with the plan for those two ariticles.
Self-Review
In this section, please self-review (answer all questions) on a suitable review checklist prior to requesting review from others. Select a review checklist based on what content is being merged in; see the Review Checklists section.
Reviewer Instructions
Reviewers, please copy and paste a suitable review checklist into your review and answer all questions.
Appendix
This section should be the same for all PRs. Do not edit this section when creating a PR.
Review Checklists
Checklists maintained by the eLev lab for research repositories include:
Standard checklist