search

ioos / notebooks_demos

Notebook demonstrations and examples
https://ioos.github.io/notebooks_demos/
MIT License
19 stars 19 forks source link

Create a notebook template for potential contributors #426

Closed MathewBiddle closed 3 years ago

MathewBiddle commented 3 years ago

I ran across EarthCube's notebook template a couple months ago and would like to discuss the potential to include something similar here.

MathewBiddle commented 3 years ago

Should also look at AGU's Ten simple rules for writing and sharing computational analyses in Jupyter Notebooks

ocefpaf commented 3 years ago

@MathewBiddle we discussed this briefly in our meetings but I have to confess I do not recall the final decision. Our notebooks are not really stand-alone and non-reproducible to require a template to ensure they run. That is b/c we provide an environment and we test-run them.

We only require a Title and some notebooks have an author listed, most do not. Maybe all we need is to standardize that? And both are usually checked in a PR review.

MathewBiddle commented 3 years ago

I don't think a template is necessary. However, I think it would be helpful to have a skeleton notebook for R and for Python. Each one would already be configured to use the appropriate kernel so a contributor could just copy and run from there.

If you agree @ocefpaf, lets close this and start a new PR in ioos_code_lab.

ocefpaf commented 3 years ago

Copying a notebook with a defined kernel is not recommended b/c kernel names and version changes. Users may be confused by the "missing kernel choose one" message.

ocefpaf commented 3 years ago

Let's close this and move the discussion to the lab repo.