search

edoddridge / aronnax

An idealised isopycnal model that can be run either with n+1/2 layers, or with n layers and variable bathymetry.
http://aronnax.readthedocs.io/en/latest/
MIT License
24 stars 6 forks source link

Update examples #155

Closed edoddridge closed 7 years ago

edoddridge commented 7 years ago

The examples hadn't been touched since before the python wrapper had been created. They didn't run, and they didn't provide an example of how to use the model. As such, they were of little use.

This PR updates them to use the new shiny python wrapper. The script run_examples.py runs the examples, plots the output, and converts the .png files into animated gifs for inclusion in the documentation. The documentation has been updated to include these animated gifs and has some additional text to describe them. The documentation is not complete, but is better than it was.

This PR also deletes all of the input, output, and other files associated with the examples, since they are now automatically generated by the script that runs the examples.

codecov[bot] commented 7 years ago

Codecov Report

Merging #155 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #155   +/-   ##
=======================================
  Coverage   94.09%   94.09%           
=======================================
  Files           5        5           
  Lines        1134     1134           
  Branches       57       57           
=======================================
  Hits         1067     1067           
  Misses         52       52           
  Partials       15       15

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 83fe42c...5a9bd14. Read the comment docs.