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.

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

Jump to bottom

Documentation surrounding examples #158

Open
edoddridge opened this issue Jun 23, 2017 · 0 comments
Open

Documentation surrounding examples #158

edoddridge opened this issue Jun 23, 2017 · 0 comments
Labels
documentation

Comments

@edoddridge
Copy link
Owner

edoddridge commented Jun 23, 2017 •
edited
Loading

As mentioned in #23 (comment), the documentation page for the examples is rather sparse. It would be good to provide more detail on this page, perhaps by implementing the following:

  • include and describe important sections of the aronnax.conf files, e.g.
    • simulation duration in model time, and real time
    • timestep
    • friction parameters
    • domain specifications
  • describe the initial conditions, perhaps with figures
  • describe the forcing, again, perhaps with figures
  • describe the expected results and compare with the actual results
edoddridge added a commit that referenced this issue Nov 15, 2017
@edoddridge
update examples and improve descriptions
dadbe1c 
The example `aronnax.conf` files needed `RelativeWind` parameters.
The initial conditions and forcings are described in more detail.
This partially completes #158.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@edoddridge