Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
213 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
102f327
Merge branch 'main' into update_documentation
Sierd Nov 25, 2025
0121dda
Quick test
bartvanwesten Mar 23, 2026
70a8b11
Removed test
bartvanwesten Mar 23, 2026
0020552
Revise model setup documentation
bartvanwesten Mar 24, 2026
c73c652
Revise model setup documentation
bartvanwesten Mar 24, 2026
a0be36b
Included model output documentation with examples
bartvanwesten Mar 24, 2026
a2bf0d4
Add example script for animating shear velocity
bartvanwesten Mar 24, 2026
85769bd
Revise model setup documentation
bartvanwesten Mar 24, 2026
2e60bbd
Update documentation for processes, methods, thresholds and boundary …
bartvanwesten Mar 24, 2026
744fd25
Update section title
bartvanwesten Mar 24, 2026
6f5b2ca
Added animation for guidance on solver schematization.
bartvanwesten Mar 24, 2026
f928d7c
Added guidance on advection and shear solvers
bartvanwesten Mar 24, 2026
9553a5d
Add sphinxcontrib-video to requirements
bartvanwesten Mar 24, 2026
2ceb797
Add sphinxcontrib.video to Sphinx extensions
bartvanwesten Mar 24, 2026
6197784
Update video embedding in model setup documentation
bartvanwesten Mar 24, 2026
6462528
Fix video paths and clean up HTML in model_setup.rst
bartvanwesten Mar 24, 2026
9ab93c5
Update video paths in model_setup documentation
bartvanwesten Mar 24, 2026
70a50e9
Revise schematization guidance and advection solver details
bartvanwesten Mar 24, 2026
f3e40c4
Update case descriptions and formatting in model setup
bartvanwesten Mar 24, 2026
fceb703
Add files via upload
bartvanwesten Mar 24, 2026
7efcaf5
Add custom CSS to widen content area
bartvanwesten Mar 24, 2026
45cc99e
Configure custom CSS for documentation
bartvanwesten Mar 24, 2026
206bc6c
Add custom CSS to widen content area
bartvanwesten Mar 24, 2026
2a778f5
Delete docs/images/_static directory
bartvanwesten Mar 24, 2026
bd1cc24
Reduce max-width of content area to 1000px
bartvanwesten Mar 24, 2026
e5f08ee
Increase video width from 700 to 900
bartvanwesten Mar 24, 2026
dcc310a
aeolis overview flowchart added
bartvanwesten Mar 25, 2026
a58e257
Added aeolis overview flowchart to model description
bartvanwesten Mar 25, 2026
a800eef
Add files via upload
bartvanwesten Mar 25, 2026
52b1112
Add files via upload
bartvanwesten Mar 25, 2026
868e344
Add files via upload
bartvanwesten Mar 25, 2026
a6d9c91
Remove figure from model description
bartvanwesten Mar 25, 2026
7ebc863
Update model overview figure and description
bartvanwesten Mar 25, 2026
3c6168c
Add files via upload
bartvanwesten Mar 25, 2026
a95acf3
Added video's of landforms to homepage
bartvanwesten Mar 25, 2026
92ee2c3
Refactor documentation structure
bartvanwesten Mar 25, 2026
e20ba79
Enhance video grid table styles
bartvanwesten Mar 25, 2026
b32996f
Update image display method in introduction.rst
bartvanwesten Mar 25, 2026
d4aa768
Add files via upload
bartvanwesten Mar 25, 2026
7312561
Add files via upload
bartvanwesten Mar 25, 2026
80f0754
Enhance wind shear and topographic steering documentation
bartvanwesten Mar 25, 2026
2e8c058
Update video format from AVI to MP4
bartvanwesten Mar 25, 2026
e5aa6b9
Add files via upload
bartvanwesten Mar 25, 2026
fd2c01a
Delete docs/images/rotating_shear.avi
bartvanwesten Mar 25, 2026
021a705
Revise model description for wind shear and flow separation
bartvanwesten Mar 25, 2026
4c3e0d6
Revise model descriptions and try adding advice
bartvanwesten Mar 25, 2026
d017586
Moved concept topographic steering figure
bartvanwesten Mar 26, 2026
c7c428b
Add files via upload
bartvanwesten Mar 26, 2026
f0f9f77
Added draft of short model description
bartvanwesten Mar 26, 2026
7505430
Improved short model overview (draft)
bartvanwesten Mar 26, 2026
062e2ef
Add section labels for reference
bartvanwesten Mar 26, 2026
d3a4d5d
Added more info in quick overview
bartvanwesten Mar 26, 2026
1d8b091
Added reference to quick overview
bartvanwesten Mar 26, 2026
c9c6582
Further edited quick overview section
bartvanwesten Mar 26, 2026
3dbf4e9
Enhance model setup documentation with grid files section
bartvanwesten Mar 26, 2026
b214c01
Update header levels
bartvanwesten Mar 26, 2026
8b53921
Fix reference label for time-series section
bartvanwesten Mar 26, 2026
fbdf2c1
Improved headers and cleaned intro
bartvanwesten Mar 26, 2026
be2a9dc
Revise model description
bartvanwesten Mar 26, 2026
849b17e
Updated model description structure entirely
bartvanwesten Mar 26, 2026
df23ebe
Refactor model description
bartvanwesten Mar 26, 2026
48bbd33
Fix reference for model output section in documentation
bartvanwesten Mar 26, 2026
8a72572
Clarify solver guide references and subscripts
bartvanwesten Mar 26, 2026
1ebf265
Fix update function to use ustar instead of ustar_mag
bartvanwesten Mar 26, 2026
20b4d15
Trying out different section references
bartvanwesten Mar 26, 2026
6f69cf6
Update references and wording in model description
bartvanwesten Mar 26, 2026
726d9f9
Update model description and sediment transport sections
bartvanwesten Mar 26, 2026
eb7eafd
Update references and clarify sediment transport section
bartvanwesten Mar 26, 2026
40a347c
Update model_description.rst
bartvanwesten Mar 26, 2026
621f2f9
Update formatting and section headings in model description
bartvanwesten Mar 26, 2026
79f6ac9
Revise model documentation
bartvanwesten Mar 26, 2026
14ebe0a
Update references in model_description.rst
bartvanwesten Mar 26, 2026
a34f424
Add units to various parameters in model description
bartvanwesten Mar 26, 2026
aa22c76
Improved advection scheme
bartvanwesten Mar 26, 2026
fa71559
Improve section header formatting in model_description.rst
bartvanwesten Mar 26, 2026
29430d1
Fix formatting in model_description.rst
bartvanwesten Mar 26, 2026
834ed91
Refactor sediment transport equations in documentation
bartvanwesten Mar 26, 2026
15c5ff1
Added saturated transport equations to documentation
bartvanwesten Mar 26, 2026
7b1d845
Added sediment transport velocity documentation
bartvanwesten Mar 26, 2026
9070366
Refine lists
bartvanwesten Mar 26, 2026
cac5522
Enhance model description with additional tips
bartvanwesten Mar 26, 2026
646d427
Revise sediment movement note and AeoLiS options
bartvanwesten Mar 26, 2026
2bfa805
Revise vegetation density equation in model description
bartvanwesten Mar 27, 2026
6ffa471
Minor modifications to first part of model description
bartvanwesten Mar 27, 2026
f4b3bb0
Enhance model description and bed-interaction details
bartvanwesten Mar 27, 2026
5a1b21f
Refine model description
bartvanwesten Mar 27, 2026
26c93b7
Fix formula for vegetation density in model description
bartvanwesten Mar 27, 2026
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:Bart.vanWesten@deltares.nl) at Deltares
- [Nick Cohn](mailto:nick.cohn@usace.army.mil) at U.S. Army Engineer Research and Development Center (ERDC)
- [Nick Cohn](mailto:nicholas.t.cohn@usace.army.mil) at U.S. Army Engineer Research and Development Center (ERDC)
- [Sierd de Vries](mailto:Sierd.deVries@tudelft.nl) (founder) at Delft University of Technology
- [Christa van IJzendoorn](mailto:C.O.vanIJzendoorn@tudelft.nl) at Delft University of Technology
- [Caroline Hallin](mailto:E.C.Hallin@tudelft.nl) at Delft University of Technology
- [Christa van IJzendoorn](mailto:vanijzec@oregonstate.edu) at Oregon State University
- [Caroline Hallin](mailto:caroline.hallin@tvrl.lth.se) at Lund University
- [Glenn Strypsteen](mailto:glenn.strypsteen@kuleuven.be) at Katholieke Universiteit Leuven
- [Janelle Skaden](mailto:Janelle.E.Skaden@usace.army.mil) at U.S. Army Engineer Research and Development Center (ERDC)

**Previous Members & Contributors:**
- [Bas Hoonhout](mailto:bas@hoonhout.com) (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 @@ -79,6 +79,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 @@ -88,6 +89,7 @@ def mycommand():

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


"""


Expand Down
Binary file added docs/_static/aeolis_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 24 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/* Widen the content area */
.wy-nav-content {
max-width: 1000px !important;
}

/* Remove borders and backgrounds from video grid tables */
table.borderless-table,
table.borderless-table td,
table.borderless-table tr {
border: none !important;
background: transparent !important;
background-color: transparent !important;
}

/* Remove the specific grey background RTD applies to odd rows */
table.borderless-table tr:nth-child(2n-1),
table.borderless-table tr:nth-child(2n-1) td {
background-color: transparent !important;
}

/* Optional: remove padding to make the videos sit closer together */
table.borderless-table td {
padding: 5px !important;
}
Loading
Loading