Skip to content

Commit

Permalink
Update hyperlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
vboutrou committed Nov 8, 2024
1 parent 6ffa187 commit 63e8fbe
Show file tree
Hide file tree
Showing 39 changed files with 77 additions and 17 deletions.
Binary file modified FunctionLibrary/BatteryManagementSystem.mlx
Binary file not shown.
Binary file modified FunctionLibrary/BatteryModeling.mlx
Binary file not shown.
Binary file modified FunctionLibrary/CreateScenario.mlx
Binary file not shown.
Binary file modified Images/image_8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified InstructorResources/Solutions/BatteryChargerSoln.mlx
Binary file not shown.
Binary file modified InstructorResources/Solutions/EVBatteryDesignSoln.mlx
Binary file not shown.
Binary file modified InstructorResources/Solutions/HowDoBatteryWorkSoln.mlx
Binary file not shown.
Binary file modified InstructorResources/Solutions/ModelingWithMATLABSoln.mlx
Binary file not shown.
Binary file modified InstructorResources/Solutions/ModelingWithSimscapeSoln.mlx
Binary file not shown.
Binary file modified InstructorResources/Solutions/ModelingWithSimulinkSoln.mlx
Binary file not shown.
Binary file modified InstructorResources/Solutions/StateOfChargeSoln.mlx
Binary file not shown.
Binary file modified InstructorResources/Solutions/ThermalModelingSoln.mlx
Binary file not shown.
Binary file modified MainMenu.mlx
Binary file not shown.
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,16 @@

# <span style="color:rgb(213,80,0)">Battery Systems: introduction </span>


[![View on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/172770-battery-systems-introduction) or [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Battery-Systems&project=BatterySystem.prj&file=README.mlx)

[![MATLAB Versions Tested](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FMathWorks-Teaching-Resources%2FBattery-Systems%2Frelease%2FImages%2FTestedWith.json)](https://MathWorks-Teaching-Resources.github.io/Battery-Systems)

**Curriculum Module**

_Created with R2024a. Compatible with R2024a and later releases._

# Information

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 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.
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/image_0.png" width="19" alt="image_0.png"> Stop button in the **RUN** section of the **Live Editor** tab in the MATLAB Toolstrip.

## Contact Us

Expand All @@ -35,14 +25,14 @@ This module assumes knowledge of electrical circuits as discussed in [DC Circuit
### Accessing the Module
### **On MATLAB Online:**

Use the [<img src="Images/OpenInMO.png" width="136" alt="OpenInMO.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Battery-Systems&project=BatterySystem.prj) link to download the module. You will be prompted to log in or create a MathWorks account. The project will be loaded, and you will see an app with several navigation options to get you started.
Use the [<img src="Images/image_1.png" width="136" alt="image_1.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Battery-Systems&project=BatterySystem.prj) link to download the module. You will be prompted to log in or create a MathWorks account. The project will be loaded, and you will see an app with several navigation options to get you started.

### **On Desktop:**

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&file=README.mlx). 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**.
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/image_2.png" width="16" alt="image_2.png"> **Add-Ons** > **Get Add-Ons**.


## Products
Expand Down Expand Up @@ -74,26 +64,32 @@ This module uses all of the following products:
## [**BatteryModeling.mlx**](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Battery-Systems&project=BatterySystem.prj&file=&file=FunctionLibrary/BatteryModeling.mlx)
| | |
| :-- | :-- |
| <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> |
| <img src="Images/image_5.svg" width="171" alt="image_5.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**](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Battery-Systems&project=BatterySystem.prj&file=Scripts/ThermalModeling.mlx)
| | |
| :-- | :-- |
| <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> |
| <img src="Images/image_6.svg" width="171" alt="image_6.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**](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Battery-Systems&project=BatterySystem.prj&file=&file=FunctionLibrary/BatteryManagementSystem.mlx)
| | |
| :-- | :-- |
| <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> |
| <img src="Images/image_7.png" width="171" alt="image_7.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
## [Power Electronics](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Power-Electronics&project=PowerElectronics.prj&file=README.mlx)
| | |
| :-- | :-- |
| <img src="Images/image_8.png" width="171" alt="image_8.png"> <br> | **Available on:** <br> [<img src="Images/image_9.png" width="91" alt="image_9.png">](https://www.mathworks.com/matlabcentral/fileexchange/173035-power-electronics) <br> [<img src="Images/image_10.png" width="136" alt="image_10.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Power-Electronics&project=PowerElectronics.prj&file=README.mlx) <br> [GitHub](https://github.com/MathWorks-Teaching-Resources/Power-Electronics) <br> |
| | |

## [ 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> |
| <img src="Images/image_11.png" width="171" alt="image_11.png"> <br> | **Available on:** <br> [<img src="Images/image_12.png" width="91" alt="image_12.png">](https://www.mathworks.com/matlabcentral/fileexchange/103375-dc-circuit-analysis) <br> [<img src="Images/image_13.png" width="136" alt="image_13.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> |
| | |


Expand Down
Binary file modified README.mlx
Binary file not shown.
Binary file modified Scripts/BatteryCharger.mlx
Binary file not shown.
Binary file modified Scripts/EVBatteryDesign.mlx
Binary file not shown.
Binary file modified Scripts/HowDoBatteryWork.mlx
Binary file not shown.
Binary file modified Scripts/ModelingWithMATLAB.mlx
Binary file not shown.
Binary file modified Scripts/ModelingWithSimscape.mlx
Binary file not shown.
Binary file modified Scripts/ModelingWithSimulink.mlx
Binary file not shown.
Binary file modified Scripts/StateOfCharge.mlx
Binary file not shown.
Binary file modified Scripts/ThermalModeling.mlx
Binary file not shown.
3 changes: 3 additions & 0 deletions SoftwareTests/PostFiles/PostBatteryChargerSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
% Post-run script for BatteryChargerSoln.mlx
% ---- Post-run commands -----

3 changes: 3 additions & 0 deletions SoftwareTests/PostFiles/PostEVBatteryDesignSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
% Post-run script for EVBatteryDesignSoln.mlx
% ---- Post-run commands -----

3 changes: 3 additions & 0 deletions SoftwareTests/PostFiles/PostHowDoBatteryWorkSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
% Post-run script for HowDoBatteryWorkSoln.mlx
% ---- Post-run commands -----

3 changes: 3 additions & 0 deletions SoftwareTests/PostFiles/PostModelingWithMATLABSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
% Post-run script for ModelingWithMATLABSoln.mlx
% ---- Post-run commands -----

3 changes: 3 additions & 0 deletions SoftwareTests/PostFiles/PostModelingWithSimscapeSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
% Post-run script for ModelingWithSimscapeSoln.mlx
% ---- Post-run commands -----

3 changes: 3 additions & 0 deletions SoftwareTests/PostFiles/PostModelingWithSimulinkSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
% Post-run script for ModelingWithSimulinkSoln.mlx
% ---- Post-run commands -----

3 changes: 3 additions & 0 deletions SoftwareTests/PostFiles/PostStateOfChargeSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
% Post-run script for StateOfChargeSoln.mlx
% ---- Post-run commands -----

3 changes: 3 additions & 0 deletions SoftwareTests/PostFiles/PostThermalModelingSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
% Post-run script for ThermalModelingSoln.mlx
% ---- Post-run commands -----

5 changes: 5 additions & 0 deletions SoftwareTests/PreFiles/PreBatteryChargerSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
% Pre-run script for BatteryChargerSoln.mlx
% ---- Known Issues -----
KnownIssuesID = "";
% ---- Pre-run commands -----

5 changes: 5 additions & 0 deletions SoftwareTests/PreFiles/PreEVBatteryDesignSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
% Pre-run script for EVBatteryDesignSoln.mlx
% ---- Known Issues -----
KnownIssuesID = "";
% ---- Pre-run commands -----

5 changes: 5 additions & 0 deletions SoftwareTests/PreFiles/PreHowDoBatteryWorkSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
% Pre-run script for HowDoBatteryWorkSoln.mlx
% ---- Known Issues -----
KnownIssuesID = "";
% ---- Pre-run commands -----

5 changes: 5 additions & 0 deletions SoftwareTests/PreFiles/PreModelingWithMATLABSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
% Pre-run script for ModelingWithMATLABSoln.mlx
% ---- Known Issues -----
KnownIssuesID = "";
% ---- Pre-run commands -----

5 changes: 5 additions & 0 deletions SoftwareTests/PreFiles/PreModelingWithSimscapeSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
% Pre-run script for ModelingWithSimscapeSoln.mlx
% ---- Known Issues -----
KnownIssuesID = "";
% ---- Pre-run commands -----

5 changes: 5 additions & 0 deletions SoftwareTests/PreFiles/PreModelingWithSimulinkSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
% Pre-run script for ModelingWithSimulinkSoln.mlx
% ---- Known Issues -----
KnownIssuesID = "";
% ---- Pre-run commands -----

5 changes: 5 additions & 0 deletions SoftwareTests/PreFiles/PreStateOfChargeSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
% Pre-run script for StateOfChargeSoln.mlx
% ---- Known Issues -----
KnownIssuesID = "";
% ---- Pre-run commands -----

5 changes: 5 additions & 0 deletions SoftwareTests/PreFiles/PreThermalModelingSoln.m
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
% Pre-run script for ThermalModelingSoln.mlx
% ---- Known Issues -----
KnownIssuesID = "";
% ---- Pre-run commands -----

0 comments on commit 63e8fbe

Please sign in to comment.