-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
317a18e
commit 53a449b
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,29 @@ | ||
Demonstration cases | ||
=================== | ||
In the `example folder ... you find a collection of input files needed to run example models. | ||
|
||
|
||
1. Install aeolis | ||
|
||
pip install aeolis | ||
|
||
2. Install the examples | ||
|
||
To install the examples do the following: | ||
|
||
.. code-block:: bash | ||
|
||
aeolis examples . | ||
|
||
This will install the examples in the current directory. If you want to install them in a different directory, replace the "." with the path to the directory you want to install the examples in. | ||
|
||
3. Run the simulation | ||
|
||
Run the simulation with: | ||
|
||
.. code-block:: bash | ||
|
||
aeolis run aeolis_examples/parabolic_dune_model/aeolis.txt | ||
|
||
|
||
4. View/plot the results |