Skip to content

Docstring and updated examples for ifft surface elevation #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2023
Merged

Docstring and updated examples for ifft surface elevation #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55275af
add docstrings to surface_elevation
akeeste Jul 25, 2023
be79494
update surface_elevation calls in examples
akeeste Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 10 additions & 17 deletions examples/extreme_response_contour_example.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

442 changes: 224 additions & 218 deletions examples/extreme_response_full_sea_state_example.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

85 changes: 42 additions & 43 deletions examples/short_term_extremes_example.ipynb
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions mhkit/wave/resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,8 @@ def surface_elevation(S, time_index, seed=None, frequency_bins=None, phases=None
for example, time = np.arange(0,100,0.01)
seed: int (optional)
Random seed
frequency_bins: numpy array or pandas DataFrame (optional)
Bin widths for frequency of S. Required for unevenly sized bins
phases: numpy array or pandas DataFrame (optional)
Explicit phases for frequency components (overrides seed)
for example, phases = np.random.rand(len(S)) * 2 * np.pi
Expand Down