Skip to content

Commit 96dc8b4

Browse files
authored
Fix warnings in the documentation build (#360)
- fixes minor spacings/lines/issues that show up as warnings
1 parent 424338b commit 96dc8b4

21 files changed

+177
-132
lines changed

examples/ADCP_Delft3D_TRTS_example.ipynb

Lines changed: 7 additions & 2 deletions
Large diffs are not rendered by default.

examples/PacWave_resource_characterization_example.ipynb

Lines changed: 72 additions & 66 deletions
Large diffs are not rendered by default.

examples/SWAN_example.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"source": [
77
"# MHKiT SWAN Example\n",
88
"\n",
9-
"This example notebook demonstrates the input and plotting of output data from the software [Simulating WAves Nearshore (SWAN)](http://swanmodel.sourceforge.net/) using MHKiT. In this example the [SNL-SWAN](https://github.com/SNL-WaterPower/SNL-SWAN) tutorial was run for a wave energy converter. The output was written in ASCII and binary (*.mat) files. This MHKiT example notebook demonstrates how to import these different files into MHKiT and plot the output data. First, we will import the MHKiT SWAN package and the other Python packages needed for this example. Secondly, we will create an operating system independent path to the folder housing the SWAN data used in this example `swan_data_folder` using the `join` funtion. "
9+
"This example notebook demonstrates the input and plotting of output data from the software [Simulating WAves Nearshore (SWAN)](http://swanmodel.sourceforge.net/) using MHKiT. In this example the [SNL-SWAN](https://github.com/SNL-WaterPower/SNL-SWAN) tutorial was run for a wave energy converter. The output was written in ASCII and binary (`*.mat`) files. This MHKiT example notebook demonstrates how to import these different files into MHKiT and plot the output data. First, we will import the MHKiT SWAN package and the other Python packages needed for this example. Secondly, we will create an operating system independent path to the folder housing the SWAN data used in this example `swan_data_folder` using the `join` function. "
1010
]
1111
},
1212
{
@@ -29,7 +29,7 @@
2929
"source": [
3030
"## Supported SWAN Output Files\n",
3131
"\n",
32-
"MHKiT currenlty supports block and table SWAN output files in ASCII or binary (*.mat) files. Detailed descriptions of these file types may be found in the [SWAN User Manual](http://swanmodel.sourceforge.net/download/zip/swanuse.pdf). In the following cells, SWAN table and block data will be imported, discussed, and plotted. Three SWAN output files will be imported:\n",
32+
"MHKiT currenlty supports block and table SWAN output files in ASCII or binary (`*.mat`) files. Detailed descriptions of these file types may be found in the [SWAN User Manual](http://swanmodel.sourceforge.net/download/zip/swanuse.pdf). In the following cells, SWAN table and block data will be imported, discussed, and plotted. Three SWAN output files will be imported:\n",
3333
" 1. An ASCII table file ('SWANOUT.DAT'), \n",
3434
" 2. An ASCII block file ('SWANOUTBlock.DAT') \n",
3535
" 3. A binary block file ('SWANOUT.mat') "
-779 KB
Binary file not shown.
-67.5 KB
Binary file not shown.

examples/data/strain/global_cs.png

-157 KB
Binary file not shown.
-89.2 KB
Binary file not shown.
-119 KB
Binary file not shown.

examples/data/strain/rotation.png

-93 KB
Binary file not shown.

examples/strain_measurement_example.ipynb

Lines changed: 46 additions & 35 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)