nansencenter / DAPPER

Data Assimilation with Python: a Package for Experimental Research
https://nansencenter.github.io/DAPPER
MIT License
341 stars 119 forks source link

Completion (TODOs) of #79 #82

Closed cgrudz closed 3 years ago

cgrudz commented 3 years ago

Filled in most of the TODO fields and made some additional notes, see the last commit message for further info.

patnr commented 3 years ago

Thanks, looks good now!

Note that I made changes to the PR by pushing to your master. So you will need to pull these changes to your local repo before doing more work to avoid conflicts. In the future you can avoid this by creating the PRs from other branches (e.g. named after the feature you're adding).

The changes I made are pretty cosmetic. The main thing was to set the appropriate spacing so that jupytext converts the headings properly to the Jupyter format. You can try it out by firing up jupyter in your venv. Once you've opened the example script, you can then ask juyterext to save a .ipynb version. If you commit this, then users can run the script on Colab (without installing anything) via the button here