Merge pull request #87 from pjpmarques/master

Contributing with examples
SciML · Mar 3, 2016 · c12fc36 · c12fc36
2 parents f89d5f3 + 3c74c18
commit c12fc36
Show file tree

Hide file tree

Showing 5 changed files with 711 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,12 @@ Additionally, `ode23s` solver supports
 
 There are also fixed step Runge-Kutta and Rosenbrock solvers available.
 
+# Examples
+The examples directory contain a few notebooks that show how to get started. You can also see them here:
+* [Simple differential equation](http://nbviewer.jupyter.org/github/JuliaLang/ODE.jl/blob/master/examples/Simple_Differential_Equation.ipynb)
+* [Lorenz Attractor](http://nbviewer.jupyter.org/github/JuliaLang/ODE.jl/blob/master/examples/Lorenz_Attractor.ipynb)
+* [Terminal Velocity](http://nbviewer.jupyter.org/github/JuliaLang/ODE.jl/blob/master/examples/Terminal_Velocity.ipynb)
+
 # Need something long-term reliable right now?
 
 See [the Sundials.jl package](https://github.com/julialang/sundials.jl), which provides wrappers for the excellent Sundials ODE solver library.
diff --git a/examples/Lorenz_Attractor.ipynb b/examples/Lorenz_Attractor.ipynb
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,10 @@
+# Examples
+
+This directory contains a few examples. For running them you will need to have [Jupyter](http://jupyter.org/) installed and the following libraries:
+* [ODE.jl](https://github.com/JuliaLang/ODE.jl)
+* [PyPlot](https://github.com/stevengj/PyPlot.jl)
+
+You can also directly see the result without installing anything. Just follow the links:
+* [Simple differential equation](http://nbviewer.jupyter.org/github/JuliaLang/ODE.jl/blob/master/examples/Simple_Differential_Equation.ipynb)
+* [Lorenz Attractor](http://nbviewer.jupyter.org/github/JuliaLang/ODE.jl/blob/master/examples/Lorenz_Attractor.ipynb)
+* [Terminal Velocity](http://nbviewer.jupyter.org/github/JuliaLang/ODE.jl/blob/master/examples/Terminal_Velocity.ipynb)
diff --git a/examples/Simple_Differential_Equation.ipynb b/examples/Simple_Differential_Equation.ipynb
diff --git a/examples/Terminal_Velocity.ipynb b/examples/Terminal_Velocity.ipynb