Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
added some content to README file, still not completed
  • Loading branch information
RoyaSahraei authored Oct 8, 2024
1 parent aa79566 commit 9dec860
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,27 +42,29 @@ for barrier island evolution that incorporates both tidal and overwash sediment
###############################################################################
## Default initial conditions
###############################################################################

```bash
barrier_model_on = True # overwash and shoreface formulations on or off

ast_model_on = True # alongshore transport on or off

inlet_model_on = False # inlets on or off

```
###############################################################################
# wave climate parameters
###############################################################################

```bash
wave_height = 1 # mean offshore significant wave height [s],

wave_period = 10 # mean wave period [m],

wave_asym = 0.8 # fraction of waves approaching from left (looking onshore),

wave_high = 0.2 # " " from angles higher than 45 degrees from shore normal,

alongshore distribution of wave energy

```
###############################################################################
# alongshore distribution of wave energy
###############################################################################
```bash
wave_climl = 180 # resolution of possible wave approach angles (1 per deg)

AngArray = np.linspace(-0.5*np.pi, 0.5*np.pi, wave_climl)
Expand All @@ -71,11 +73,11 @@ k for alongshore transport, from Nienhuis, Ashton, Giosan 2015 (Ashton 2006
value for k is wrong)

k = 5.3e-06*1050*(g**1.5)*(0.5**1.2)*(np.sqrt(g*0.78)/(2*np.pi))**0.2

```
###############################################################################
# barrier model parameters
###############################################################################

```bash
slr = 2e-03 # sea level rise rate [m/yr]

s_background = 1e-03 # background cross-shore slope (beta)
Expand Down Expand Up @@ -109,7 +111,7 @@ dt = 0.05 # timestep of the numerical model [years]
nt = 1e4#1e5 # number of timesteps

dtsave = 1e3 # save spacing

```
|Build Status|


Expand Down

0 comments on commit 9dec860

Please sign in to comment.