Contributing with examples

[pjpmarques]

Happy to contribute with a few jupyter notebooks on how to use the package.
You can check the examples/result here:

• Simple differential equation
• Lorenz Attractor
• Terminal Velocity

[mauro3]

These links would need to point to this repo and not your fork.

[tomasaschan]

It might be (but isn't necessarily) nice to first merge this, though, and then when the notebooks exist in ODE.jl, refer to them with a specific hash rather than master. This would ensure that links aren't broken by mistake if/when the notebooks are (re)moved, but on the other hand it would require manual update of all links when the notebooks are changed, even if the location did not change; and furthermore, that manual change would not be possible to make before the changes to the notebooks have been committed.

[mauro3]

Ideally the notebooks would be checked with each commit. Is this possible?

[tomasaschan]

"Checked" as in "run-through with no errors"?

No idea - I doubt that it's easy. It would be a nice feature of IJulia, though, so if it doesn't exist it's worth a feature request there. I imagine something like this:

using IJulia
run_all_cells("path/to/notebook.ipynb")

and as a first step the test would just verify that running the above code doesn't throw. (More features could include checking expected output from each cell, checking expected STDOUT printouts etc, but just running without crashing is a good start.)

[mauro3]

Thanks for these examples! I think the would be good to have in ODE.jl.

At the moment there are no docs for ODE.jl. But one thing to ponder is how we'd like to have examples. Are notebooks a suitable format? However, if the answer is "no", then these could be ported over.

A few comments for the Lorenz notebook (for some reason, I cannot do them inline):

• put a link to wikipedia in the intro?
• remove "Let's implement it in Julia."
• make your global sigma, rho, bet all const
• any reason to not use ode45?

Also, squash the commits into one. And, I think, the by Paulo Marques, 2014/01/28 should be removed.

[pjpmarques]

Hi. Glad to correct the code and follow the suggestions. I've:

• Solved the links problem pointing to outside repository.
• Marked constants with "const"
• Gave credit to Wikimedia and include references to wikipedia
• Changed ode23() to ode45()
• Removed personal credit
• Corrected some incorrect notation (use of == instead of =; use of YY instead of Y)
• Use of less colloquial style
• Squashed all commits into one

Note that now the links will appear to be broken because they are pointing to ODE.jl/master, which still doesn't contain this code. It will only render properly after the merge.

[pjpmarques]

Hi. Any news on this and/or do you want me to correct something? Thanks.

[mauro3]

LGTM