Skip to content

Commit 73b16ca

Browse files
committed
Updated Repo README with initial getting started
1 parent 87d03a0 commit 73b16ca

File tree

7 files changed

+16
-13
lines changed

7 files changed

+16
-13
lines changed

README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
# Simulink Models
22

33
## Folder structure
4-
- models: simulink models
5-
- config: shared configuration files
4+
- autogen: contains the Autogen framework
5+
- models: simulink model projects utilizing the Autogen framework
6+
- config: path configuration files for the Autogen framework
67
- test_signals: audio files for testing the models
8+
9+
10+
## Getting started with a new Simulink Model
11+
- Create the Simulink Model matching Autogen examples
12+
- Run `config/pathSetup.m`
13+
- Create `model.json` using `createModelJson`, ex. `createModelJson("echo")`
14+
- (optional) Create `modelparameters.m` for additional configuration
15+
- (optional) Create `sm_stop_verify.m` for verifying simulation
16+
17+
More information on `model.json`, `modelparameters.m`, and `sm_stop_verify.m` can be found [here](autogen/README.md)

autogen/sm_stop_process_output.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
data = data(idxvalid);
4242
channel = channel(idxvalid);
4343

44-
% Remove fields for different number of samples (TODO: is this needed?)
44+
% Remove fields for different number of samples
4545
data_field = "data_out";
4646
if isfield(mp, data_field)
4747
mp = rmfield(mp, data_field);

models/echo/resources/project/Root.type.EntryPoints/485df011-e288-46b6-8204-03de50f54782.type.EntryPoint.xml

-2
This file was deleted.

models/echo/resources/project/Root.type.References/03deb6b8-9329-4dc1-9625-a92c34e4f529.type.Reference.xml

-2
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<Info Type="StartUp" Visible="0" Icon="" File="config/pathSetup.m" Name="pathSetup" />

resources/project/Root.type.Files/config.type.File/pathSetupWindows.m.type.File.xml

-6
This file was deleted.

0 commit comments

Comments
 (0)