Skip to content

Commit cde57cf

Browse files
Merge pull request #154 from m2lines/dhruvbalwada-patch-4
Update README.md
2 parents 1980cfd + ee9d68c commit cde57cf

File tree

3 files changed

+33
-2
lines changed

3 files changed

+33
-2
lines changed

README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@
33
[![build-and-deploy-book](https://github.com/m2lines/L96_demo/actions/workflows/deploy.yml/badge.svg)](https://github.com/m2lines/L96_demo/actions/workflows/deploy.yml)
44
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/m2lines/L96_demo/HEAD)
55

6+
7+
This repository provides a set of notebooks to pedagogically introduce the reader to the problem of parameterization in the climate sciences and how machine learning may be used to address it.
8+
9+
The original goal for these notebooks in this Jupyter book was for our [M2LInES](https://m2lines.github.io/) team to work together and learn from each other; in particular, to get up to speed on the key scientific aspects of our collaboration (parameterizations, machine learning, data assimilation, uncertainty quantification) and to develop new ideas. Now this material is presented here for anyone to learn from. The primary audience for this guide is researchers and students trained in climate science wanting to be introduced to machine learning or trained in machine learning and want to get acquainted with the parameterization problem in climate sciences. Since the book addresses people from multiple fields the level of pre-requisites required is minimal; a basic understanding of Python and some experience with PDEs or dynamical systems and solving them numerically (an introductory course in numerical methods) can be helpful. This book could be used as a teaching tool, for self-study, or as a reference manual.
10+
11+
The easiest way to read the content (non-interactively) is to view it through the book's [website](https://m2lines.github.io/L96_demo/intro.html). For more interactive experience either use the binder link provided above, or setup the appropriate environments on your own machine and interact with each notebook indivdually.
12+
613
## Structure and Organization of the Repo
714

815
This project uses [Jupyter Book](https://jupyterbook.org/) to organize a collection of
@@ -47,6 +54,8 @@ This file lives in [conda-linux-64.lock](https://github.com/m2lines/L96_demo/blo
4754

4855
## Building the Book
4956

57+
Most readers interested in learning from this material could just run individual notebooks once they have setup the appropriate environment, or use the binder link provided at the top of this readme. However, some more advanced readers, particularly those wishing to contribute back, may be interested in building the book locally for testing purposes.
58+
5059
To build the book locally, you should first create and activate your environment,
5160
as described above. Then run
5261

@@ -80,7 +89,15 @@ To remove cached notebooks, run
8089
$ jcache cache remove -p _build/.jupyter_cache
8190
```
8291

83-
## Contributing
92+
## Contributing and reporting problems
93+
94+
If you find any problems or mistakes in the material, think something is not clear, or spot errors in the codes, please [open a new issue](https://github.com/m2lines/L96_demo/issues/new) to report these or seek help.
95+
96+
Also, we welcome any contributions that you would like to make. These can come in the form of:
97+
- Providing solutions to any errors or clarity issues you or others may have spotted and reported on the issues page.
98+
- Suggest and create new notebooks for any additional concepts that are not currently covered.
99+
100+
These contributions can also be made by [opening a new issue](https://github.com/m2lines/L96_demo/issues/new) and starting a discussion about what you would like to contribute, and eventually submitting changes in the form of a new pull request.
84101

85102
### Pre-commit
86103

@@ -157,7 +174,7 @@ $ git fetch upstream
157174
$ git merge upstream/main
158175
```
159176

160-
Ideally you will not have any merge conflicts.
177+
Ideally, you will not have any merge conflicts.
161178
You are now ready to make a new feature branch.
162179

163180
## References

paper.md

+7
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,13 @@ The material in this Jupyter book is presented over five sections. The first sec
157157

158158
The book was created by and as part of M2LInES, an international collaboration supported by Schmidt Futures, to improve climate models with scientific machine learning. The original goal for these notebooks in this Jupyter book was for our team to work together and learn from each other; in particular, to get up to speed on the key scientific aspects of our collaboration (parameterizations, machine learning, data assimilation, uncertainty quantification) and to develop new ideas. This was done as a series of tutorials, each of which was led by a few team members and occurred with a frequency of roughly once every 2 weeks for about 6-7 months. This Jupyter book is a collection of the notebooks used during these tutorials, which have only slightly been edited for continuity and clarity. Ultimately, we are happy to share these resources with the scientific community to introduce our research ideas and foster the use of machine learning techniques for tackling climate science problems.
159159

160+
# Statement of Need
161+
Parameterization of sub-grid processes is a major challenge in climate modeling. The details of this problem may often be very context dependent (@christensen2022parametrization), but much can be learned by addressing the issue in a general and simpler sense. Also, a general approach allows non-domain experts, e.g. machine learning researchers, to engage and contribute more meaningfully. This JupyterBook aims to achieve this target with the help of a simple dynamical system model - Lorenz 96, such that the reader is introduced to the basic concepts with minimal superfluous complexity. It is possible to extend the concepts that are presented here to other dynamical systems, and even to more complex parameterization tasks (some examples can be found at https://m2lines.github.io/publications/), and we hope that researchers and learners aiming to do this find the concepts presented here as a useful stepping stone in this pursuit.
162+
163+
As described above, these notebooks were originally created to introduce non-domain experts to ideas from the parameterization aspects of climate modeling and how machine learning could be used to potentially address these. Now they have been adapted to act as a pedagogical tool for self-learning, be used as a reference manual, or for teaching some modules in an introductory class on machine learning.
164+
The book is organized in sections that are relatively independent; with the exception that the first section provides a general overview to the parameterization problem in climate models.
165+
Each notebook covers material that can be discussed in roughly an hour-long lecture, and sections can be mixed and matched or ordered as needed depending on the overall learning objectives.
166+
160167

161168
# Acknowledgements
162169
This work is supported by the generosity of Eric and Wendy Schmidt by recommendation of Schmidt Futures, as part of its Virtual Earth System Research Institute (VESRI). MAB acknowledges support from National Science Foundation's AGS-PRF Fellowship Award (AGS2218197).

references.bib

+7
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
% L96 Jupyter Book
22
3+
@article{christensen2022parametrization,
4+
title={Parametrization in weather and climate models},
5+
author={Christensen, Hannah and Zanna, Laure},
6+
year={2022},
7+
publisher={Oxford University Press}
8+
}
9+
310
@article{Lorenz1995,
411
title = {Predictability: a problem partly solved},
512
journal = {Seminar on Predictability},

0 commit comments

Comments
 (0)