search

passaH2O / dorado

For shallow-water Lagrangian particle routing.
https://passah2o.github.io/dorado
MIT License
54 stars 9 forks source link

Expand documentation #6

Closed elbeejay closed 4 years ago

elbeejay commented 4 years ago

So this PR does 4 things, largely in response to suggestions from here.

  1. Add links to external examples below our examples

  2. Remove the instructions to conda-install the package as they were not working for all operating systems

  3. Expand to contribution guidelines to make it the opening of issues and PRs more clear

  4. Add "import matplotlib.pyplot as plt" to the first quickstart example. Also provide a bit more background information on that example, what is going on and why it might be of interest.

Edit: This would close #8