Skip to content

Commit

Permalink
updated readme to include suggested pre-work and installation tips
Browse files Browse the repository at this point in the history
  • Loading branch information
callieEDU committed Jun 8, 2023
1 parent 6260e75 commit c9b1538
Showing 1 changed file with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,21 @@ _Created with R2021a. Compatible with R2021a and later releases._
## Description ##
The Virtual Controls Laboratory contains virtual models of several mechanisms commonly used in controls courses. These virtual mechanisms offer opportunities to visually analyze dynamic systems, identify system parameters, design and test controllers, among others. Instructions for four introductory labs are included. These labs are designed to give an intuitive introduction to basic controls concepts, such as feedback control. Students also have the opportunity to implement and test simple controllers in Simulink®.

Get started with the Virtual Controls Laboratory by downloading and unzipping the repository. Then, double-click the project .prj file inside MATLAB®. From there, you can follow the landing page instructions to get started with the labs and virtual mechanisms.
These modules connect the theory and application of the specific subject, which will support various student learning objectives. These lessons can be used as part of a lecture to supplement learning, as activities in an instructional setting, or as interactive assignments to be completed outside class.

## Get started with the Virtual Controls Laboratory interactive examples ##

**Option 1: Download to Desktop** Download and unzip the repository. Then, double-click the VirtualControlsLabortory.prj file inside MATLAB&reg;. If you open a script or model and MATLAB notifies you that a certain toolbox is not installed, click the arrow on the <img src="https://github.com/MathWorks-Teaching-Resources/Virtual-Controls-Laboratory/assets/88105902/079f23c8-11cc-46e9-a935-26dccf0b32eb"> **Add-Ons** button in the **ENVIRONMENT** section on the **HOME** tab in the MATLAB Toolstrip. Then, navigate to **Manage Add-ons** to install the necessary toolboxes.

**Option 2: [Open in MATLAB Online](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Virtual-Controls-Laboratory&project=VirtualControlsLabortory.prj)** Log in to your MathWorks account to access your license. If you are associated with a university, use your university email to access a license.

- From there, you can follow the landing page instructions to get started with the examples.
- The instructions inside the live scripts will guide you through the exercises and activities.
- Get started with each live script by running it one section at a time.
- To stop running the script or a section midway (for example, if a loop is running longer than intended), click the <img src="https://user-images.githubusercontent.com/88841524/182219991-17ef7bf9-369b-4463-8de6-9e440ca3bc9b.png"> **Stop** button in the **RUN** section of the **Live Editor** tab in the MATLAB Toolstrip.

## Prerequisite Domain Knowledge ##
These scripts assume some familiarity with open/closed loop feedback control, deriving transfer functions, PID controllers, and stability control (poles and zeros). It is possible to work through this module without extensive experience in MATLAB and Simulink. However, some background in these products will be helpful. Please see the suggested pre-work section below for self-paced tutorials that can support quicker onboarding.

## Details ##

Expand All @@ -17,7 +31,7 @@ Get started with the Virtual Controls Laboratory by downloading and unzipping th
<td width=290>
<b>Cruise control</b>
<br><code>CruiseControl.slx</code>
<img src = "./SupportingFiles/gifs/vehiclecover.png" alt="Vehicle animation" width=250>
<img src = "./SupportingFiles/gifs/cruisecontrol.gif" alt="Vehicle animation" width=250>
</td>
<td width=290>
<b>DC motor</b>
Expand Down Expand Up @@ -49,7 +63,6 @@ Get started with the Virtual Controls Laboratory by downloading and unzipping th
</tr>
</table>


### Labs ###
**Lab 1: Cruise control `(Lab1_CruiseControl.mlx)`**
A virtual lab that explores the basics of open-loop and feedback control.
Expand Down Expand Up @@ -90,9 +103,11 @@ In this lab, students construct and analyze the closed-loop transfer function of
- Assess the stability of a closed-loop transfer function.

## Suggested Prework ##
[MATLAB Onramp](https://matlabacademy.mathworks.com/details/matlab-onramp/gettingstarted) – a free two-hour introductory tutorial that teaches the essentials of MATLAB.
<br>
[Simulink Onramp](https://matlabacademy.mathworks.com/details/simulink-onramp/simulink) – a free three-hour introductory tutorial that teaches the essentials of Simulink.
The suggested prework detailed below are complementary interactive online courses available for all to use with a valid MathWorks account.

* [MATLAB Onramp](https://matlabacademy.mathworks.com/details/matlab-onramp/gettingstarted) – a free two-hour introductory tutorial that teaches the basics of programming in MATLAB.
* [Simulink Onramp](https://matlabacademy.mathworks.com/details/simulink-onramp/simulink) – a free two-hour introductory tutorial that teaches the basics of simulating mathematical models in Simulink.
* [Control Design Onramp with Simulink](https://matlabacademy.mathworks.com/details/control-design-onramp-with-simulink/controls) - a free one-hour introductory tutorial that teaches the basics of control design in Simulink.

## Products ##
MATLAB, Simulink, Control System Toolbox&trade;, Simscape&trade;, Simscape Multibody&trade;, Simscape Driveline&trade;
Expand All @@ -101,9 +116,9 @@ MATLAB, Simulink, Control System Toolbox&trade;, Simscape&trade;, Simscape Multi
The license for this module is available in the [LICENSE.md](license.md) file in this GitHub repository.

## Educator Resources ##
* [Transfer Function Analysis of Dynamics Systems Courseware](https://www.mathworks.com/matlabcentral/fileexchange/94635-transfer-function-analysis-of-dynamic-systems?s_tid=srchtitle)
* [Featured Courseware](https://www.mathworks.com/academia/courseware/course-materials.html)
* [Teach with MATLAB and Simulink](https://www.mathworks.com/academia/educators.html)
* [MATLAB Grader](https://www.mathworks.com/products/matlab-grader.html)
* [Resources for Educators](https://www.mathworks.com/academia/educators.html)

The lab solutions are available upon instructor request. If you would like to request solutions or have a question, contact the <a href="mailto:onlineteaching@mathworks.com">MathWorks online teaching team.</a> If you are having technical issues using MATLAB, please contact our [Technical Support Team](https://www.mathworks.com/support/contact_us.html).

Expand Down

0 comments on commit c9b1538

Please sign in to comment.