-
Notifications
You must be signed in to change notification settings - Fork 51
/
Copy pathREADME.md
70 lines (54 loc) · 3.5 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# WEC-Sim_Applications
[](https://github.com/WEC-Sim/WEC-Sim_Applications/actions/workflows/wec-sim-main-tests.yml)
[](https://github.com/WEC-Sim/WEC-Sim_Applications/actions/workflows/wec-sim-dev-tests.yml)
This repository contains applications of the WEC-Sim code, including tutorials by the WEC-Sim team as well as user-shared examples.
To contribute an example follow these guidelines:
- Create a new branch off the `dev` branch.
- Create a folder on the top level with a single example (folders starting with a dot or underscore are ignored).
- Do not include results as these take up space and can easily be generated by running the example.
- Using the _README_template.md_ file create a _README.md_ file for your example. Include the example name, the author, WEC-Sim version, and description.
- Using the TestB2B.m test as a template, create a _TestCASE.m_ file that will run BEMIO and check the functionality of your application when changes are made to the WEC-Sim source code.
- Include any required MATLAB toolboxes in a text file called `products.txt`. Use one line per toolbox and use the same naming conventions as described for the `products` input to the [Setup MATLAB][106] action.
- Create a [pull request][101] against the `dev` branch. The WEC-Sim team will review your example and add it to the repo.
## Testing Applications
Tests are provided for the applications using the MATLAB [unit testing
framework][102].
Individual test files are typically found at the same level as a `hydroData`
directory, with a file name like `Test<Something>.m`. These test files may test
multiple application cases that use the same hydrodynamic data.
For the latest release of WEC-Sim_Applications, or the `main` branch, it is
assumed that the latest release or `main` branch of [WEC-Sim][103] is
installed. For tests containing the name "MoorDyn", it is also necessary to
install the [MoorDyn][104] module into WEC-Sim. The tests in the
`Desalination` folder require the [Simscape Fluids][105] toolbox.
Assuming that the WEC-Sim_Applications source code is located at some path
`\path\to\WEC-Sim_Applications`, then to test the Body-to-Body Interaction
application cases, the following commands can be given in the MATLAB interface:
```matlab
>> cd \path\to\WEC-Sim_Applications\Body-to-Body_Interactions
>> runtests("TestB2B.m")
...
```
Alternatively, the `TestB2B.m` file can be opened in the MATLAB editor and
then the tests can be run by selecting the `Run Tests` action in the `EDITOR`
ribbon.
A shortcut for running all the tests in the repository is provided at the
root level with the `wecSimAppTest.m` function. This function can be run from
the root directory, as follows:
```matlab
>> cd \path\to\WEC-Sim_Applications
>> wecSimAppTest
...
```
Alternatively, the function can also be used to run tests in a particular
directory. For instance, run the tests in the `End_Stops` directory as follows:
```matlab
>> wecSimAppTest End_Stops
...
```
[101]: https://help.github.com/articles/using-pull-requests/
[102]: https://uk.mathworks.com/help/matlab/matlab-unit-test-framework.html
[103]: https://github.com/WEC-Sim/WEC-Sim
[104]: https://github.com/WEC-Sim/MoorDyn
[105]: https://www.mathworks.com/products/simscape-fluids.html
[106]: https://github.com/matlab-actions/setup-matlab?tab=readme-ov-file#set-up-matlab