Skip to content

Commit 4476aa1

Browse files
committed
Update project root README.md
1 parent 3f94dda commit 4476aa1

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

README.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![View Hybrid Electric Vehicle Model in Simscape on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/92820-hybrid-electric-vehicle-model-in-simscape)
44

5-
Version 1.2.alpha
5+
Version 1.2
66

77
## Introduction
88

@@ -42,8 +42,8 @@ physical components are built and tested individually
4242
and also they can be easily integrated into
4343
a complete vehicle system model.
4444

45-
The HEV model and its components are managed in
46-
a MATLAB project and
45+
The HEV model and its component files are managed
46+
by a MATLAB project and
4747
some components come with their own test setups.
4848

4949
![Model Screenshot](utils/image_PowerSplitHEV_system_model.png)
@@ -68,10 +68,6 @@ Optional:
6868

6969
## What's New in Version 1.2
7070

71-
_This section is subject to change._
72-
73-
Version 1.2 is currently in development and may be broken :)
74-
7571
Highlights
7672

7773
- **MATLAB Unit Test** files are added for some models and scripts.
@@ -84,6 +80,10 @@ Highlights
8480

8581
Models
8682

83+
- Power-Split HEV system model is refactored to clean up.
84+
Previously two separate system models existed
85+
for speed tracking simulation and direct torque input simulation.
86+
They are now merged into one.
8787
- Battery block from Simscape Electrical is added as
8888
a new referenced subsystem for High-Voltage Battery component.
8989
The previous model is included as well.
@@ -104,33 +104,41 @@ Models
104104
thereby improving simulation robustness and performance.
105105
- MG1 controller can start the engine.
106106
This better models the power-split HEV controller.
107-
- In `PowerSplitHEV_SpeedTracking` model,
108-
Scopes are moved to individual components.
109-
This cleans up the model and makes model navigation easier.
107+
- Scopes are moved to individual components.
108+
This cleans up models, streamlines development workflow,
109+
and makes model navigation easier.
110110

111111
Test
112112

113113
- Project top-level unit test is added.
114114
See files under `test`.
115-
- `HEVProject_runtests.m`
116-
automatically finds all unit test implementation files
115+
- `HEVProject_runtests.m` automatically finds all unit test files
117116
in the project folder tree and runs them.
118117
`.github/workflow/ci.yml` for GitHub Actions uses this
119-
to perform unit test.
120-
- Power-Split HEV system has unit test files
121-
in `HEV` > `PowerSplitHEV_SpeedTracking` > `test`.
122-
- Unit test implementation: `PowerSplitHEV_SpeedTracking_UnitTest.m`.
123-
- Test runner: `PowerSplitHEV_SpeedTracking_runtests.m`.
124-
Running this script performs unit test and produces
125-
a MATLAB code coverage report in HTML.
126-
- Power-Split Drive Unit component has unit test files
127-
in `Components` > `PowerSplitDriveUnit` > `test`.
128-
- Engine component has unit test files
129-
in `Components` > `Engine` > `test`.
118+
to perform unit test when the repository is pushed to GitHub.
119+
- Power-Split HEV system model has unit test files in
120+
- `HEV` > `PowerSplitHEV_DirectInput` > `test`
121+
- `HEV` > `PowerSplitHEV_SpeedTracking` > `test`
122+
- Unit test files:
123+
- `PowerSplitHEV_DirectInput_UnitTest.m`
124+
- `PowerSplitHEV_SpeedTracking_UnitTest.m`
125+
- Test runners:
126+
- `PowerSplitHEV_DirectInput_runtests.m`
127+
- `PowerSplitHEV_SpeedTracking_runtests.m`
128+
- Running these scripts perform unit test and produce
129+
MATLAB code coverage report.
130+
- Vehicle1D component has unit test files in
131+
- `Components` > `Vehicle1D` > `test`
132+
- Power-Split Drive Unit component has unit test files in
133+
- `Components` > `PowerSplitDriveUnit` > `test`
134+
- Engine component has unit test files in
135+
- `Components` > `Engine` > `test`
136+
- Drive Pattern component has unit test files in
137+
- `Components` > `DrivePattern` > `test`
130138

131139
Other updates
132140

133-
- Cleaned up some folders, models, and scripts.
141+
- Refactored many folders, models, and scripts.
134142

135143
## What's New in Version 1.1
136144

0 commit comments

Comments
 (0)