diff --git a/README.md b/README.md index 06fddbb..d25826c 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,14 @@ _Created with R2024a. Compatible with R2024a and later releases._ -# Information +# Information -This curriculum module contains interactive [MATLAB® live scripts](https://www.mathworks.com/products/matlab/live-editor.html) that contains learning material covering fundamental concept and terminology of battery systems. There is a focus on designing and modeling battery system using different tools (MATLAB, Simulink and Simscape). +This curriculum module contains interactive [ MATLAB® live scripts](https://www.mathworks.com/products/matlab/live-editor.html) that contain learning material covering the fundamental concepts and terminology of battery systems. The focus is on designing and modeling battery systems using different tools (MATLAB, Simulink, and Simscape). ## Background -You can use these live scripts as demonstrations in lectures, class activities, or interactive assignments outside class. This module covers basic battery pack design, battery cell modeling (electrical and thermal) and the basic of battery management system. It also includes examples of modeling using different approach (MATLAB, Simulink and Simscape) and State of Charge (SoC) estimation. +You can use these live scripts as demonstrations in lectures, class activities, or interactive assignments outside class. This module covers basic battery pack design, battery cell modeling (electrical and thermal), and the basics of battery management systems. It also includes examples of modeling using different approaches (MATLAB, Simulink, and Simscape) and State of Charge (SoC) estimation. 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, when an animation is in progress), use the EndIcon.png Stop button in the **RUN** section of the **Live Editor** tab in the MATLAB Toolstrip. @@ -29,7 +29,7 @@ Solutions are available upon instructor request. Contact the [MathWorks teaching ## Prerequisites -This module assumes knowledge of electrical circuit as discussed in [DC Circuit Analysis](https://github.com/MathWorks-Teaching-Resources/DC-Circuit-Analysis). There is minimal MATLAB knowledge required for these scripts, but you could use [MATLAB Onramp](https://matlabacademy.mathworks.com/details/matlab-onramp/gettingstarted) as a resources to acquire familiarity with live scripts and MATLAB syntax. Depending on your learning path through the module, you might want to add [Simulink Onramp](https://matlabacademy.mathworks.com/details/simulink-onramp/simulink) or [Simscape Onramp](https://matlabacademy.mathworks.com/details/simscape-onramp/simscape) to gain familiarity with these tools. +This module assumes knowledge of electrical circuits as discussed in [DC Circuit Analysis](https://github.com/MathWorks-Teaching-Resources/DC-Circuit-Analysis). There is minimal MATLAB knowledge required for these scripts, but you could use [MATLAB Onramp](https://matlabacademy.mathworks.com/details/matlab-onramp/gettingstarted) as a resource to acquire familiarity with live scripts and MATLAB syntax. Depending on your learning path through the module, you might want to add [Simulink Onramp](https://matlabacademy.mathworks.com/details/simulink-onramp/simulink) or [Simscape Onramp](https://matlabacademy.mathworks.com/details/simscape-onramp/simscape) to gain familiarity with these tools. ## Getting Started ### Accessing the Module @@ -39,7 +39,7 @@ Use the [OpenInMO.png](https:/ ### **On Desktop:** -Download or clone this repository. Open MATLAB, navigate to the folder containing these scripts and double\-click on [BatterySystem.prj](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Battery-Systems&project=BatterySystem.prj). It will add the appropriate files to your MATLAB path and open an app that asks you where you would like to start. +Download or clone this repository. Open MATLAB, navigate to the folder containing these scripts, and double\-click [BatterySystem.prj](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Battery-Systems&project=BatterySystem.prj). It will add the appropriate files to your MATLAB path and open an app that asks you where you would like to start. Ensure you have all the required products (listed below) installed. If you need to include a product, add it using the Add\-On Explorer. To install an add\-on, go to the **Home** tab and select AddOnsIcon.png **Add-Ons** > **Get Add-Ons**. @@ -47,48 +47,54 @@ Ensure you have all the required products (listed below) installed. If you need ## Products -This module uses all of following products: +This module uses all of the following products: - MATLAB® - Simulink® - Simscape™ +- Simscape Battery™ +- Simscape Electrical™ - Symbolic Math Toolbox™ +- Curve Fitting Toolbox™ +- Statistics and Machine Learning Toolbox™ # Scripts - - *If you are viewing this in a version of MATLAB prior to R2023b, you can view the learning outcomes for each script* [*here*](https://www.mathworks.com/matlabcentral/fileexchange/Battery-Systems) - -## [HowDoBatteryWork.mlx](Scripts/HowDoBatteryWork.mlx) -| | | +## [**HowDoBatteryWork.mlx**](Scripts/HowDoBatteryWork.mlx) +| | | | :-- | :-- | -| image_3.svg | **In this script, students will...**
- Learn about the different components of a battery.
- Learn how batteries work.
- Build a functional model of a battery.
| +| image_3.svg
| **In this script, students will...**
$\bullet$ Learn about the different components of a battery.
$\bullet$ Learn how batteries work.
$\bullet$ Build a functional model of a battery.
| +| | | - -## [EVBatteryDesign.mlx](Scripts/EVBatteryDesign.mlx) -| | | +## [**EVBatteryDesign.mlx**](Scripts/EVBatteryDesign.mlx) +| | | | :-- | :-- | -| image_4.svg | **In this script, students will...**
- Be able to understand battery configuration (parallel, series).
- Determine power and energy requirement for a battery pack.
- Validate their design through simulation.
| +| image_4.svg
| **In this script, students will...**
$\bullet$ Be able to understand battery configuration (parallel, series).
$\bullet$ Determine power and energy requirements for a battery pack.
$\bullet$ Validate their design through simulation.
| +| | | -## [BatteryModeling.mlx](FunctionLibrary/BatteryModeling.mlx) -| | | +## [**BatteryModeling.mlx**](FunctionLibrary/BatteryModeling.mlx) +| | | | :-- | :-- | -| energy-storage.svg
| **In this script, students will...**
- Learn about battery modeling principles.
- Conduct experimental observations and data analysis.
- Develop and calibrate an equivalent circuit model for a battery cell.
| +| energy-storage.svg
| **In this script, students will...**
$\bullet$ Learn about battery modeling principles.
$\bullet$ Conduct experimental observations and data analysis.
$\bullet$ Develop and calibrate an equivalent circuit model for a battery cell.
| +| | | -## [ThermalModeling.mlx](Scripts/ThermalModeling.mlx) -| | | +## [**ThermalModeling.mlx**](Scripts/ThermalModeling.mlx) +| | | | :-- | :-- | -| Thermal.svg
| **In this script, students will...**
- Learn about battery thermal modeling principles.
- Develop computation model of battery heating and cooling.
- Compare different heating and cooling scenario.
| +| Thermal.svg
| **In this script, students will...**
$\bullet$ Learn about battery thermal modeling principles.
$\bullet$ Develop a computation model of battery heating and cooling.
$\bullet$ Compare different heating and cooling scenarios.
| +| | | -## [BatteryManagementSystem.mlx](FunctionLibrary/BatteryManagementSystem.mlx) -| | | +## [**BatteryManagementSystem.mlx**](FunctionLibrary/BatteryManagementSystem.mlx) +| | | | :-- | :-- | -| SoC.png
| **In this script, students will...**
- Learn about constant voltage and constant current charging.
- Develop algorithms to estimate a battery state of charge (SoC).
| +| SoC.png
| **In this script, students will...**
$\bullet$ Learn about constant voltage and constant current charging.
$\bullet$ Develop algorithms to estimate a battery state of charge (SoC).
| +| | | # Related Courseware Modules ## [ DC Circuit Analysis](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/DC-Circuit-Analysis&project=DCCircuitAnalysis.prj) -| | | +| | | | :-- | :-- | | image_8.png
| **Available on:**
[OpenInFX.png](https://www.mathworks.com/matlabcentral/fileexchange/103375-dc-circuit-analysis)
[OpenInMO.png](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/DC-Circuit-Analysis&project=DCCircuitAnalysis.prj)
[GitHub](https://github.com/MathWorks-Teaching-Resources/DC-Circuit-Analysis)
| +| | | Or feel free to explore our other [modular courseware content](https://www.mathworks.com/matlabcentral/fileexchange/?q=tag%3A%22courseware+module%22&sort=downloads_desc_30d). @@ -104,4 +110,3 @@ Looking for more? Find an issue? Have a suggestion? Please contact the [MathWork *©* Copyright 2024 The MathWorks™, Inc - diff --git a/README.mlx b/README.mlx index 67e41c2..e2eb380 100644 Binary files a/README.mlx and b/README.mlx differ