Skip to content

Commit 693ae0f

Browse files
authored
Merge pull request #98 from xmos/master
Merge minor readme update back to develop
2 parents 5e60abc + e3bb065 commit 693ae0f

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

doc/python/README.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@ INTRODUCTION
22
============
33

44
This folder includes a python script which runs the C emulators for the ASRC, SSRC, OS3 and DS3 modules.
5-
For each model we present test signals - both a single tone to test the THD performance and a range of tones to
6-
observe roll-off at the top of the band.
7-
Using an un-windowed FFT we calculate the SNR.
8-
We scrape the logs to extract MIPS/Utilization where supported.
5+
For each model test signals are injected - both a single tone to test the THD performance and a range of tones to
6+
observe roll-off at the top of the band. Using an un-windowed FFT the SNR and THD is calculated.
7+
The logs are scraped to extract MIPS and utilization where supported.
98

109
Tests are run for all suported input and output sample freqencies, and for worst case frequency deviation.
11-
Note that not all modules support all input scenarios - these are ignored.
10+
Note that not all modules support all input scenarios due to input and output rate specifications - these cases are ignored.
1211

13-
The result of this script is the generation an rst file which is included into the documentation,
12+
The result of this script is the generation an `rst` file which is included into the documentation,
1413
incorporating a full set of charts and summary table.
1514

1615

0 commit comments

Comments
 (0)