leap-stc / leap-stc/ClimSim

Clean up demo notebooks

Open
#27 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation website
Dominant language
Jupyter Notebook
Stars
164
Forks
54
PR merge metrics
No merged PRs in 30d

Description

I think it would be a good idea to clean up the notebooks in demo_notebooks a little bit, especially because we are planning to include them on the website. A few suggestions:

  • Removing the commented out code. Let's keep these notebooks tidy!
  • Moving some of the class and function definitions to modules to make the notebooks more compact.
  • Including a short introduction at the beginning of each notebook to summarize what will be done.
  • Possibly including Figure 1 and 2 from the Supplementary Information (which show the network architectures) of the ClimSim paper at the beginning of the two notebooks cnn_example.ipynb and mlp_example.ipynb.
  • Including a few more figures on the way (if possible), and make the figures look a little bit nicer. A website / notebooks with nice figures will be read by more people - no joke!

I am happy to help with this, if other people agree with the suggestions above. @jerrylin96 @cisaacstern?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the notebooks in demo_notebooks, especially cnn_example.ipynb and mlp_example.ipynb, and compare their current contents with the issue checklist. Done means commented-out code is removed, suitable definitions are moved to modules, each notebook has an introduction, and the requested architecture and additional figures are included where appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.