Skip to content

Commit

Permalink
Modify README.md and README.mlx
Browse files Browse the repository at this point in the history
  • Loading branch information
@vboutrou
vboutrou committed Sep 26, 2024
1 parent 5a5ff7e commit 6b8c87d
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 27 deletions.
59 changes: 32 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 <img src="Images/EndIcon.png" width="19" alt="EndIcon.png"> Stop button in the **RUN** section of the **Live Editor** tab in the MATLAB Toolstrip.
Expand All @@ -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
Expand All @@ -39,56 +39,62 @@ Use the [<img src="Images/OpenInMO.png" width="136" alt="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 <img src="Images/AddOnsIcon.png" width="16" alt="AddOnsIcon.png"> **Add-Ons** > **Get Add-Ons**.


## 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)
| | |
| :-- | :-- |
| <img src="Images/image_3.svg" width="171" alt="image_3.svg"> | **In this script, students will...** <br> - Learn about the different components of a battery. <br> - Learn how batteries work. <br> - Build a functional model of a battery. <br> |
| <img src="Images/image_3.svg" width="171" alt="image_3.svg"> <br> | **In this script, students will...** <br> $\bullet$ Learn about the different components of a battery. <br> $\bullet$ Learn how batteries work. <br> $\bullet$ Build a functional model of a battery. <br> |
| | |


## [EVBatteryDesign.mlx](Scripts/EVBatteryDesign.mlx)
| | |
## [**EVBatteryDesign.mlx**](Scripts/EVBatteryDesign.mlx)
| | |
| :-- | :-- |
| <img src="Images/image_4.svg" width="157" alt="image_4.svg"> | **In this script, students will...** <br> - Be able to understand battery configuration (parallel, series). <br> - Determine power and energy requirement for a battery pack. <br> - Validate their design through simulation. <br> |
| <img src="Images/image_4.svg" width="157" alt="image_4.svg"> <br> | **In this script, students will...** <br> $\bullet$ Be able to understand battery configuration (parallel, series). <br> $\bullet$ Determine power and energy requirements for a battery pack. <br> $\bullet$ Validate their design through simulation. <br> |
| | |

## [BatteryModeling.mlx](FunctionLibrary/BatteryModeling.mlx)
| | |
## [**BatteryModeling.mlx**](FunctionLibrary/BatteryModeling.mlx)
| | |
| :-- | :-- |
| <img src="Images/energy-storage.svg" width="171" alt="energy-storage.svg"> <br> | **In this script, students will...** <br>- Learn about battery modeling principles. <br>- Conduct experimental observations and data analysis. <br>- Develop and calibrate an equivalent circuit model for a battery cell. <br> |
| <img src="Images/energy-storage.svg" width="171" alt="energy-storage.svg"> <br> | **In this script, students will...** <br> $\bullet$ Learn about battery modeling principles. <br> $\bullet$ Conduct experimental observations and data analysis. <br> $\bullet$ Develop and calibrate an equivalent circuit model for a battery cell. <br> |
| | |

## [ThermalModeling.mlx](Scripts/ThermalModeling.mlx)
| | |
## [**ThermalModeling.mlx**](Scripts/ThermalModeling.mlx)
| | |
| :-- | :-- |
| <img src="Images/Thermal.svg" width="171" alt="Thermal.svg"> <br> | **In this script, students will...** <br> - Learn about battery thermal modeling principles. <br>- Develop computation model of battery heating and cooling. <br>- Compare different heating and cooling scenario. <br> |
| <img src="Images/Thermal.svg" width="171" alt="Thermal.svg"> <br> | **In this script, students will...** <br> $\bullet$ Learn about battery thermal modeling principles. <br> $\bullet$ Develop a computation model of battery heating and cooling. <br> $\bullet$ Compare different heating and cooling scenarios. <br> |
| | |

## [BatteryManagementSystem.mlx](FunctionLibrary/BatteryManagementSystem.mlx)
| | |
## [**BatteryManagementSystem.mlx**](FunctionLibrary/BatteryManagementSystem.mlx)
| | |
| :-- | :-- |
| <img src="Images/SoC.png" width="171" alt="SoC.png"> <br> | **In this script, students will...** <br>- Learn about constant voltage and constant current charging. <br>- Develop algorithms to estimate a battery state of charge (SoC). <br> |
| <img src="Images/SoC.png" width="171" alt="SoC.png"> <br> | **In this script, students will...** <br> $\bullet$ Learn about constant voltage and constant current charging. <br> $\bullet$ Develop algorithms to estimate a battery state of charge (SoC). <br> |
| | |

# Related Courseware Modules
## [ DC Circuit Analysis](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/DC-Circuit-Analysis&project=DCCircuitAnalysis.prj)
| | |
| | |
| :-- | :-- |
| <img src="Images/image_8.png" width="171" alt="image_8.png"> <br> | **Available on:** <br> [<img src="Images/OpenInFX.png" width="91" alt="OpenInFX.png">](https://www.mathworks.com/matlabcentral/fileexchange/103375-dc-circuit-analysis) <br> [<img src="Images/OpenInMO.png" width="136" alt="OpenInMO.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/DC-Circuit-Analysis&project=DCCircuitAnalysis.prj) <br> [GitHub](https://github.com/MathWorks-Teaching-Resources/DC-Circuit-Analysis) <br> |
| | |


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).
Expand All @@ -104,4 +110,3 @@ Looking for more? Find an issue? Have a suggestion? Please contact the [MathWork
*©* Copyright 2024 The MathWorks™, Inc



Binary file modified README.mlx
View file
Binary file not shown.

0 comments on commit 6b8c87d

Please sign in to comment.