Skip to content

Commit d3cc2d9

Browse files
committed
move to img/
1 parent 4738e6a commit d3cc2d9

5 files changed

Lines changed: 42 additions & 13 deletions

File tree

README.md

Lines changed: 42 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,63 @@
11
# Coupled Finite Difference Kirchhoff Plate And String
2+
23
A collection of Finite Difference models coupling a Kirchhoff Thin Plate and Stiff String along with related functions
34

4-
# Contents
5+
<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
6+
7+
- [Coupled Finite Difference Kirchhoff Plate And String](#coupled-finite-difference-kirchhoff-plate-and-string)
8+
- [Contents](#contents)
9+
- [`schemes`](#schemes)
10+
- [`instrument files`](#instrument-files)
11+
- [`calibration files`](#calibration-files)
12+
- [`midi`](#midi)
13+
- [`functions`](#functions)
14+
- [`analysis`](#analysis)
15+
- [`documents`](#documents)
16+
- [Example Plots](#example-plots)
17+
- [Version Notes](#version-notes)
18+
19+
<!-- /TOC -->
20+
21+
## Contents
22+
523
An environment setup script has been provided to ensure that all the required folders and functions are visible.
624

7-
### schemes
25+
### `schemes`
26+
827
The individual finite difference models. Each scheme is currently bundled with the relevant instrument file though others are included
928

10-
### instrument files
29+
### `instrument files`
30+
1131
template instrument files for each model
1232

13-
### calibration files
33+
### `calibration files`
34+
1435
Files containing arrays of coefficients that were calibrated against real piano recordings.
1536

16-
### midi
37+
### `midi`
38+
1739
A selection of midi files for use with models that generate audio from MIDI data.
1840

19-
### functions
41+
### `functions`
42+
2043
useful functions used in the model process
2144

22-
### analysis
45+
### `analysis`
46+
2347
files for generating plots for analysing model behaviour.
2448

25-
### documents
49+
### `documents`
50+
2651
supporting documentation in pdf and markdown format
2752

28-
# Example Plots
29-
<img src="https://github.com/mhamilt/CoupledFDPlateAndString/blob/master/images/plate_wave.png" width="100%" height="50%">
30-
<img src="https://github.com/mhamilt/CoupledFDPlateAndString/blob/master/images/string_plate.png" width="100%" height="50%">
53+
## Example Plots
54+
55+
| ![ ](./img/plots/plate_wave.png) | ![ ](./img/plots/string_plate.png) |
56+
| -------------------------------- | ---------------------------------- |
57+
| | |
58+
59+
60+
## Version Notes
3161

32-
# Version Notes
3362
NOTE: The included files were created with MATLAB 2016b on macOS. Some behaviour may be slightly different, particularly with
34-
vector .* element-wise multiplication. I've routed out most of these but there may still be a few lurking in bushes.
63+
vector `.\*` element-wise multiplication. I have routed out most of these but there may still be a few lurking in bushes.

0 commit comments

Comments
 (0)