Skip to content

Commit 64e4b7e

Browse files
committed
Readme update
1 parent 3f8c286 commit 64e4b7e

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

Overview/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Single-page reference for how the BEV Simscape repository is organized, where tr
1818
| `Script_Data/Setup/User/` | Generated setup/param scripts from app export (gitignored) |
1919
| [`Workflow/`](../Workflow/README.md) | Engineering workflows — Battery, MotorDrive, Vehicle (range estimation) |
2020
| `Overview/` | Published MATLAB overview pages (`.m` source → `html/` output) |
21-
| `Overview/Image/` | Images referenced by overview documentation |
21+
| `Overview/html/Image/` | Images referenced by overview documentation |
2222
| [`Test/`](../Test/README.md) | Project-level test suite — system model, workflow, and project checks |
2323
| `utils/` | Shared utilities — signal designer, cell characterization methods |
2424

@@ -85,7 +85,7 @@ Every component under `Components/` follows this structure:
8585
| `TestCase/` | Yes | MATLAB unit tests (`*PassTests.m`) |
8686
| `Documentation/` | Yes | Source `.m` description files |
8787
| `Documentation/html/` | Yes | Published HTML from source |
88-
| `Documentation/images/` | Yes | Screenshots and figures |
88+
| `Documentation/html/images/` | Yes | Screenshots and figures |
8989
| `Utilities/` | Some | Plot functions and helper scripts |
9090
| `Library/` | Few | Shared Simulink library blocks (BatteryHV, HVAC, MotorDrive) |
9191
| `README.md` | Yes | Component-level summary |
@@ -195,7 +195,7 @@ Ready-to-use preset configurations are shipped in `Script_Data/Setup/Preset/`. E
195195
### Rules
196196

197197
- Source `.m` files are the canonical copy. Never patch generated HTML directly.
198-
- Images generated during publish go to `Documentation/images/`. HTML `src=` attributes reference `../images/`.
198+
- Images generated during publish go to `Documentation/html/images/`. HTML `src=` attributes reference `images/` (same-folder subfolder).
199199
- Cross-links between published pages use relative paths (same-folder links use just the filename).
200200
- The App loads component HTML via `ComponentDescription()`, which searches `Components/**/Documentation/html/` by fidelity name.
201201

Overview/html/ElectricVehicleComponentOverview.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h2 id="1">Components Folder Structure</h2>
118118
<tr><td><code>TestBench/</code></td><td>Standalone test harness with boundary conditions</td></tr>
119119
<tr><td><code>TestCase/</code></td><td>MATLAB unit tests (<code>*PassTests.m</code>)</td></tr>
120120
<tr><td><code>Documentation/html/</code></td><td>Published HTML documentation pages</td></tr>
121-
<tr><td><code>Documentation/images/</code></td><td>Screenshots and figures</td></tr>
121+
<tr><td><code>Documentation/html/images/</code></td><td>Screenshots and figures</td></tr>
122122
<tr><td><code>Utilities/</code></td><td>Plot functions and helper scripts</td></tr>
123123
<tr><td><code>Library/</code></td><td>Shared Simulink library blocks (select components only)</td></tr>
124124
<tr><td><code>README.md</code></td><td>Component-level summary and usage notes</td></tr>
@@ -356,7 +356,7 @@ <h2 id="8">See Also</h2>
356356
% <tr><td><code>TestBench/</code></td><td>Standalone test harness with boundary conditions</td></tr>
357357
% <tr><td><code>TestCase/</code></td><td>MATLAB unit tests (<code>*PassTests.m</code>)</td></tr>
358358
% <tr><td><code>Documentation/html/</code></td><td>Published HTML documentation pages</td></tr>
359-
% <tr><td><code>Documentation/images/</code></td><td>Screenshots and figures</td></tr>
359+
% <tr><td><code>Documentation/html/images/</code></td><td>Screenshots and figures</td></tr>
360360
% <tr><td><code>Utilities/</code></td><td>Plot functions and helper scripts</td></tr>
361361
% <tr><td><code>Library/</code></td><td>Shared Simulink library blocks (select components only)</td></tr>
362362
% <tr><td><code>README.md</code></td><td>Component-level summary and usage notes</td></tr>

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ as well as the overall system.
4040
### Range Estimation for Electric Vehicle
4141
<table>
4242
<tr>
43-
<td class="image-column" width=400><img src="Overview/Image/BatteryElectricVehicleModelOverview_01.png" alt="BEV system model canvas"></td>
43+
<td class="image-column" width=400><img src="Overview/html/Image/BatteryElectricVehicleModelOverview_01.png" alt="BEV system model canvas"></td>
4444
<td class="text-column" width=200> </td>
4545
<td class="text-column" width=300>Estimate the on-road range of the vehicle. Run drive cycles with different ambient conditions to determine the range of the vehicle with a given capacity. See <strong><a href="Workflow/Vehicle/RangeEstimation/README.md">Workflow/Vehicle/RangeEstimation</a></strong>.</td>
4646
</tr>
@@ -50,14 +50,14 @@ as well as the overall system.
5050
<table>
5151
<tr>
5252
<td class="text-column" width=600>Size your high-voltage (HV) battery pack to achieve your desired range. You will learn how to simulate battery packs with different capacities and weights, and compare them based on how these factors affect the range of the vehicle. See <strong><a href="Workflow/Battery/BatterySizing/README.md">Workflow/Battery/BatterySizing</a></strong>.</td>
53-
<td class="image-column" width=300><img src="Overview/Image/BEVplantModelbatterysSubs.png" alt="Battery Sizing"></td>
53+
<td class="image-column" width=300><img src="Overview/html/Image/BEVplantModelbatterysSubs.png" alt="Battery Sizing"></td>
5454
</tr>
5555
</table>
5656

5757
### Analyze Thermal Durability for PMSM
5858
<table>
5959
<tr>
60-
<td class="image-column" width=600><img src="Overview/Image/BatteryElectricVehicleModelOverviewThermalDiagram.png" alt="Thermal PMSM"></td>
60+
<td class="image-column" width=600><img src="Overview/html/Image/BatteryElectricVehicleModelOverviewThermalDiagram.png" alt="Thermal PMSM"></td>
6161
<td class="text-column" width=300>Run the thermal test bench over extended duty cycles at multiple coolant sump temperatures to assess winding and magnet thermal margins See <strong><a href="Workflow/MotorDrive/ThermalDurability/README.md">Workflow/MotorDrive/ThermalDurability</a></strong>.</td>
6262
</tr>
6363
</table>
@@ -66,14 +66,14 @@ as well as the overall system.
6666
<table>
6767
<tr>
6868
<td class="text-column" width=300>Generate copper, iron, IGBT, and diode loss maps by sweeping the FOC-controlled PMSM across speed, torque, and temperature points. See <strong><a href="Workflow/MotorDrive/GenerateMotInvLoss/README.md">Workflow/MotorDrive/GenerateMotInvLoss</a></strong>.</td>
69-
<td class="image-column" width=600><img src="Overview/Image/PMSMlossMapGen.PNG" alt="Loss Map"></td>
69+
<td class="image-column" width=600><img src="Overview/html/Image/PMSMlossMapGen.PNG" alt="Loss Map"></td>
7070
</tr>
7171
</table>
7272

7373
### Estimate Inverter Power Module End of Life
7474
<table>
7575
<tr>
76-
<td class="image-column" width=600><img src="Overview/Image/PMSMThermalTestInverterResult.png" alt="EOL"></td>
76+
<td class="image-column" width=600><img src="Overview/html/Image/PMSMThermalTestInverterResult.png" alt="EOL"></td>
7777
<td class="text-column" width=300>Capture IGBT and diode junction temperatures from drive-cycle simulations, apply rainflow cycle counting, and estimate semiconductor lifetime. See <strong><a href="Workflow/MotorDrive/GenerateMotInvLoss/README.md">Workflow/MotorDrive/GenerateMotInvLoss</a></strong>.</td>
7878
</tr>
7979
</table>
@@ -82,14 +82,14 @@ as well as the overall system.
8282
<table>
8383
<tr>
8484
<td class="text-column" width=300>Sweep candidate gear ratios over EUDC and US06 cycles on the thermal test bench and compare magnet and winding temperatures to find the best ratio. See <strong><a href="Workflow/MotorDrive/GearRatioSelect/README.md">Workflow/MotorDrive/GearRatioSelect</a></strong>.</td>
85-
<td class="image-column" width=600><img src="Overview/Image/PMSMThermalTestGearResult.png" alt="Gear Ratio"></td>
85+
<td class="image-column" width=600><img src="Overview/html/Image/PMSMThermalTestGearResult.png" alt="Gear Ratio"></td>
8686
</tr>
8787
</table>
8888

8989
### Build Virtual Sensor for BMS
9090
<table>
9191
<tr>
92-
<td class="image-column" width=600><img src="Overview/Image/BatteryNeuralNetResults.png" alt="Battery NN"></td>
92+
<td class="image-column" width=600><img src="Overview/html/Image/BatteryNeuralNetResults.png" alt="Battery NN"></td>
9393
<td class="text-column" width=300>Train a neural network to predict battery cell temperature from current, voltage, and SOC inputs. A pre-trained model is included for verification. See <strong><a href="Workflow/Battery/VirtualSensorNeuralNetModel/README.md">Workflow/Battery/VirtualSensorNeuralNetModel</a></strong>.</td>
9494
</tr>
9595
</table>
@@ -99,7 +99,7 @@ as well as the overall system.
9999
## 🛠️ Utilities
100100
<table>
101101
<tr>
102-
<td class="image-column" width=400><img src="APP/Documents/images/BEVappWindow.png" alt="BEV APP"></td>
102+
<td class="image-column" width=400><img src="APP/Documents/html/images/BEVappWindow.png" alt="BEV APP"></td>
103103
<td class="text-column" width=100></td>
104104
<td class="text-column" width=400>You can also launch the <a href="APP/README.md">BEV Setup App</a> (<code>BEVapp</code>) to select
105105
a template, choose component fidelities, link parameter files, and configure environment, HVAC, and driver settings for your vehicle model.</td>

0 commit comments

Comments
 (0)