Skip to content
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.

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

Update documentation #205

Open
wants to merge 126 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
126 commits
Select commit Hold shift + click to select a range
b0d970c
Update README.md
CarolineHalllin Jul 23, 2024
649f716
Update model.rst
CarolineHalllin Jul 23, 2024
b1a791f
Update index.rst
CarolineHalllin Jul 23, 2024
4919b64
Update and rename bibliography.rst to references.rst
CarolineHalllin Jul 23, 2024
2ba3ada
Create introduction.rst
CarolineHalllin Jul 23, 2024
4ceb967
Rename model.rst to model_description.rst
CarolineHalllin Jul 23, 2024
c7b6246
Rename inputfiles.rst to model_setup.rst
CarolineHalllin Jul 23, 2024
e770473
Update model_setup.rst
CarolineHalllin Jul 23, 2024
cc21034
Create tutorials_and_examples.rst
CarolineHalllin Jul 23, 2024
b2e4f16
Update index.rst
CarolineHalllin Jul 24, 2024
8fd581a
Create model_interaction.rst
CarolineHalllin Jul 24, 2024
5dd798a
Update model_interaction.rst
CarolineHalllin Jul 24, 2024
b42acc9
Update model_interaction.rst
CarolineHalllin Jul 24, 2024
20f4b32
Update implementation.rst
CarolineHalllin Jul 24, 2024
fb55ab1
Update model_interaction.rst
CarolineHalllin Jul 24, 2024
4e90a30
Update introduction.rst
CarolineHalllin Jul 24, 2024
8f8d72f
Update model_setup.rst
CarolineHalllin Jul 24, 2024
dd0cfcd
Update model_setup.rst
CarolineHalllin Jul 24, 2024
ec35c39
Update model_setup.rst
CarolineHalllin Jul 24, 2024
4133048
Delete docs/user/output.rst
CarolineHalllin Jul 24, 2024
d293024
Update model_setup.rst
CarolineHalllin Jul 24, 2024
4aad034
Delete docs/user/defaults.rst
CarolineHalllin Jul 24, 2024
75993e2
Update index.rst
CarolineHalllin Jul 24, 2024
0a2a86b
Update model_description.rst
CarolineHalllin Jul 24, 2024
a466d7a
Delete docs/user/implementation.rst
CarolineHalllin Jul 24, 2024
6910e88
Update installation.rst
CarolineHalllin Jul 24, 2024
e5af1a7
Add files via upload
CarolineHalllin Jul 24, 2024
2f0e09e
Delete docs/user/whatsnew.rst
CarolineHalllin Jul 24, 2024
e266f4d
Update index.rst
CarolineHalllin Jul 24, 2024
92a2225
Update index.rst
CarolineHalllin Jul 24, 2024
81ebee6
Update introduction.rst
CarolineHalllin Jul 24, 2024
6e7a6f4
Update model_description.rst
CarolineHalllin Jul 24, 2024
067b99c
Update model_description.rst
CarolineHalllin Jul 24, 2024
ea21308
Update installation.rst
CarolineHalllin Jul 24, 2024
d09d4af
Update index.rst
CarolineHalllin Jul 24, 2024
3d2a25f
Updated the BMI documentation partially
bartvanwesten Jul 24, 2024
f3fee04
Update index.rst
CarolineHalllin Jul 24, 2024
697cdc1
Merge branch 'update_documentation' of github.com:openearth/aeolis-py…
bartvanwesten Jul 24, 2024
2918b7a
Merge branch 'update_documentation' of github.com:openearth/aeolis-py…
bartvanwesten Jul 24, 2024
4615e50
Update the BMI description
bartvanwesten Jul 24, 2024
fdfcf49
Update model_interaction.rst
bartvanwesten Jul 24, 2024
1103bbc
Update model_interaction.rst
bartvanwesten Jul 24, 2024
0f6ac7a
Update model_interaction.rst
bartvanwesten Jul 24, 2024
4a418b8
Update introduction.rst
CarolineHalllin Jul 24, 2024
c06ed59
Update introduction.rst
CarolineHalllin Jul 24, 2024
e2b783c
Update introduction.rst
CarolineHalllin Jul 24, 2024
8220846
Update constants.py
christavanijzendoorn Jul 24, 2024
d759554
Update introduction.rst
CarolineHalllin Jul 24, 2024
0b46cc9
Update model_setup.rst
christavanijzendoorn Jul 25, 2024
5674b08
Update introduction.rst
CarolineHalllin Jul 25, 2024
e85b079
Update model_description.rst
GlennStrypsteen Jul 25, 2024
4cde585
Add files via upload
GlennStrypsteen Jul 25, 2024
21f9bb4
Add files via upload
CarolineHalllin Jul 25, 2024
3857c41
Update model_description.rst
GlennStrypsteen Jul 26, 2024
361e4d1
Update model_setup.rst
christavanijzendoorn Jul 26, 2024
0e2e57f
Update model_setup.rst
christavanijzendoorn Jul 26, 2024
a7dfca4
Update aeolis.bib
GlennStrypsteen Jul 26, 2024
b916d36
Update model_setup.rst
christavanijzendoorn Jul 26, 2024
8161b65
Update model_setup.rst
christavanijzendoorn Jul 26, 2024
76d19c4
updates to index and readme file
CarolineHalllin Jul 26, 2024
0096f4d
Add files via upload
CarolineHalllin Jul 26, 2024
eb8e419
Update model_description.rst
GlennStrypsteen Jul 26, 2024
0fea7fb
Update aeolis.bib
GlennStrypsteen Jul 26, 2024
76c9ef3
Update aeolis.bib
CarolineHalllin Jul 26, 2024
4b0b1ae
Update index.rst
CarolineHalllin Jul 26, 2024
8ebeb6c
Update aeolis.bib
CarolineHalllin Jul 26, 2024
1f55275
Update index.rst
CarolineHalllin Jul 26, 2024
6d5529d
Update index.rst
CarolineHalllin Jul 26, 2024
f8e53c8
Update index.rst
CarolineHalllin Jul 26, 2024
b566cbb
Update index.rst
CarolineHalllin Jul 26, 2024
68256d2
Update index.rst
CarolineHalllin Jul 26, 2024
44c8719
Update index.rst
CarolineHalllin Jul 26, 2024
0fa888c
Update model_description.rst
CarolineHalllin Jul 26, 2024
2767cde
Update quickstart.rst
CarolineHalllin Jul 26, 2024
b2dc815
Update index.rst
CarolineHalllin Jul 26, 2024
683ba3a
Update index.rst
CarolineHalllin Jul 26, 2024
38eff70
Update index.rst
CarolineHalllin Jul 26, 2024
f263aed
Update index.rst
CarolineHalllin Jul 26, 2024
4cd3e3d
Update index.rst
CarolineHalllin Jul 26, 2024
f018923
Update model_setup.rst
CarolineHalllin Jul 26, 2024
1b27f10
Add files via upload
CarolineHalllin Jul 26, 2024
1ffab28
Update introduction.rst
CarolineHalllin Jul 26, 2024
18b818e
Update introduction.rst
CarolineHalllin Jul 26, 2024
190483a
Update model_description.rst
GlennStrypsteen Jul 26, 2024
a037665
Update index.rst
CarolineHalllin Jul 26, 2024
dc7624a
Create demonstration_cases
CarolineHalllin Jul 26, 2024
ca2ade3
Create shortcourses.rst
CarolineHalllin Jul 26, 2024
6fdb8bf
Delete docs/tutorials/demonstration_cases
CarolineHalllin Jul 26, 2024
0364c89
Create demonstration_cases.rst
CarolineHalllin Jul 26, 2024
6f72de6
Update model_description.rst
GlennStrypsteen Jul 26, 2024
8f6a87d
Update model_description.rst
GlennStrypsteen Jul 26, 2024
43e902c
Update index.rst
CarolineHalllin Jul 26, 2024
e401ec3
Update model_description.rst
GlennStrypsteen Jul 26, 2024
7c668d0
Update model_description.rst
GlennStrypsteen Jul 26, 2024
d6f15e3
Update index.rst
CarolineHalllin Jul 26, 2024
91f07e5
Update README.md
CarolineHalllin Jul 26, 2024
a44227b
Update model_description.rst
CarolineHalllin Jul 26, 2024
29479c1
Update model_description.rst
GlennStrypsteen Jul 26, 2024
3eac340
Update model_description.rst
GlennStrypsteen Jul 26, 2024
a2cdc9e
Update introduction.rst
GlennStrypsteen Jul 26, 2024
2e9705e
Update demonstration_cases.rst
CarolineHalllin Jul 26, 2024
317a18e
Update shortcourses.rst
CarolineHalllin Jul 26, 2024
53a449b
Update demonstration_cases.rst
CarolineHalllin Jul 26, 2024
fff74b3
Update demonstration_cases.rst
CarolineHalllin Jul 26, 2024
a5b4dee
Delete docs/user/tutorials_and_examples.rst
CarolineHalllin Jul 27, 2024
1accf00
Update index.rst
CarolineHalllin Jul 27, 2024
52788f1
Update demonstration_cases.rst
CarolineHalllin Jul 27, 2024
b5e1549
Update shortcourses.rst
CarolineHalllin Jul 27, 2024
25cb6d8
Delete docs/tutorials/2D-parabolic.rst
CarolineHalllin Jul 27, 2024
5adc1cc
Delete docs/tutorials/sandmotor.rst
CarolineHalllin Jul 27, 2024
7da86e8
Update demonstration_cases.rst
CarolineHalllin Jul 27, 2024
4bbb509
Update aeolis.bib
CarolineHalllin Jul 27, 2024
548103e
Update aeolis.bib
CarolineHalllin Jul 27, 2024
adc638c
Update aeolis.bib
Sierd Aug 16, 2024
096ed2e
dead link removed
Sierd Aug 16, 2024
e4acc3a
Solve minor layout issues
christavanijzendoorn Aug 16, 2024
4691fd3
Add introductory section to Model Setup
christavanijzendoorn Aug 16, 2024
380bf62
Solve minor layout issues
christavanijzendoorn Aug 16, 2024
88a6ed7
Improve demonstration cases page
christavanijzendoorn Aug 16, 2024
4f46545
Restructure model description section
christavanijzendoorn Aug 16, 2024
58d7dd9
correct small mistake in text model setup
christavanijzendoorn Aug 16, 2024
7c53b7e
General tips and getting help
christavanijzendoorn Aug 16, 2024
62b1037
Update model_setup.rst
christavanijzendoorn Aug 16, 2024
1e47588
Dropdown menu added
Sierd Aug 17, 2024
b5a5343
cleaned up bib-file, added appendix, explained solvers
Sierd Aug 17, 2024
916a863
1D/2D documentation added
Sierd Aug 18, 2024
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
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,16 @@ aeolis run <path/to/aeolis.txt/>
aeolis wind <path/to/wind.txt> --mean=6 --duration=3600
```

## Documentation
## Documentation and help
Detailed documentation can be found at [AeoLiS ReadTheDocs](http://aeolis.readthedocs.io/)

A couple of short courses are available to help new users get acquainted with the model:
- [AeoLiS short course](https://github.com/openearth/aeolis-shortcourse)
- [AeoLiS case study documentation by ERDC](https://github.com/erdc/aeolis-python/tree/master/tutorial)

Example case studies can also be found in the [examples folder](https://github.com/openearth/aeolis-python/tree/main/aeolis/examples) that is part of the AeoLiS installation.

We encourage (new) users to post questions and case studies on the [AeoLiS Discussion Board](https://github.com/openearth/aeolis-python/discussions). We use this public forum so our help and advice is available to everyone.

## AeoLiS Developer Team
The maintenance and development is done by a group of very enthusiastic people.
Expand All @@ -74,18 +81,18 @@ Read our [Contribution Guidelines](CONTRIBUTING.md) to know how you can help to
**Current Members:**

- [Bart van Westen](mailto:[email protected]) at Deltares
- [Nick Cohn](mailto:nick[email protected]) at U.S. Army Engineer Research and Development Center (ERDC)
- [Nick Cohn](mailto:nicholas.t[email protected]) at U.S. Army Engineer Research and Development Center (ERDC)
- [Sierd de Vries](mailto:[email protected]) (founder) at Delft University of Technology
- [Christa van IJzendoorn](mailto:[email protected]) at Delft University of Technology
- [Caroline Hallin](mailto:[email protected]) at Delft University of Technology
- [Christa van IJzendoorn](mailto:[email protected]) at Oregon State University
- [Caroline Hallin](mailto:[email protected]) at Lund University
- [Glenn Strypsteen](mailto:[email protected]) at Katholieke Universiteit Leuven
- [Janelle Skaden](mailto:[email protected]) at U.S. Army Engineer Research and Development Center (ERDC)

**Previous Members & Contributors:**
- [Bas Hoonhout](mailto:[email protected]) (founder)
- Tom Pak
- Pieter Rauwoens
- Lisa Meijer
- Janelle Skaden

## Citation

Expand Down
2 changes: 2 additions & 0 deletions aeolis/console.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@

@aeolis_app.command(name="mycommand", help="My command help")
def mycommand():

<add code here...>

You can then run the command from the command line as follows:
Expand All @@ -79,6 +80,7 @@ def mycommand():

***************************************************************************


"""


Expand Down
2 changes: 1 addition & 1 deletion aeolis/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@
'wind_convention' : 'nautical', # Convention used for the wind direction in the input files (cartesian or nautical)
'alfa' : 0, # [deg] Real-world grid cell orientation wrt the North (clockwise)
'dune_toe_elevation' : 3, # Choose dune toe elevation, only used in the PH12 dune erosion solver
'beach_slope' : 0.1, # Define the beach slope, only used in the PH12 dune erosion solver
'beach_slope' : 0.1, # Define the beach slope
'veg_min_elevation' : 3, # Choose the minimum elevation where vegetation can grow
'vegshear_type' : 'raupach', # Choose the Raupach grid based solver (1D or 2D) or the Okin approach (1D only)
'okin_c1_veg' : 0.48, #x/h spatial reduction factor in Okin model for use with vegetation
Expand Down
Loading
Loading