Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up demo notebooks #27

Open
5 tasks
NoraLoose opened this issue Aug 18, 2023 · 1 comment
Open
5 tasks

Clean up demo notebooks #27

NoraLoose opened this issue Aug 18, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation website

Comments

@NoraLoose
Copy link
Contributor

NoraLoose commented Aug 18, 2023

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?

@cisaacstern
Copy link
Contributor

cisaacstern commented Aug 18, 2023

Great suggestions, all of which make sense to me but also doesn't necessarily have to block #15 IMHO.

Moving some of the class and function definitions to modules to make the notebooks more compact.

This is definitely a good idea, and will also allow us to unit test all of these functions/classes with pytest.

To start this process, I would suggest adding a new module in the climsim_utils directory, and moving any functions / classes from the notebooks into that module. Then when the package is pip-installed, those objects will be available for import with:

from climsim_utils.new_module_name import function_a, class_b, etc

As a subsequent step, we'll want to think about how to structure these modules into function groups (xref #17). But to start just having them out of the notebooks is a good place to start.

@NoraLoose NoraLoose added documentation Improvements or additions to documentation website labels Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation website
Projects
None yet
Development

No branches or pull requests

2 participants