Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brian-rose/climatelaboratorybook
JupyterBook source for The Climate Laboratory
https://github.com/brian-rose/climatelaboratorybook
climate climate-model jupyter open-textbooks python
Last synced: about 4 hours ago
JSON representation
JupyterBook source for The Climate Laboratory
- Host: GitHub
- URL: https://github.com/brian-rose/climatelaboratorybook
- Owner: brian-rose
- License: other
- Created: 2020-01-03T14:58:50.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-10T12:31:08.000Z (5 months ago)
- Last Synced: 2024-06-11T16:43:00.344Z (5 months ago)
- Topics: climate, climate-model, jupyter, open-textbooks, python
- Language: Jupyter Notebook
- Homepage: https://brian-rose.github.io/ClimateLaboratoryBook
- Size: 163 MB
- Stars: 101
- Watchers: 4
- Forks: 42
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# The Climate Laboratory
[](https://zenodo.org/badge/latestdoi/231609808)
[](https://github.com/brian-rose/ClimateLaboratoryBook/actions/workflows/deploy-book.yaml)
[](https://github.com/brian-rose/ClimateLaboratoryBook/actions/workflows/link-checker.yaml)
***A hands-on approach to climate physics and climate modeling***
**By [Brian E. J. Rose][brian], University at Albany**
## About the book
This book is powered by [JupyterBook][jupyterbook],
and aims to be all of the following:
- **self-reproducing** *(most figures are self-generating in the notebooks)*
- **free** and **open** *(permissive license, sources and content available through github)*
- **interactive** *(integration with JupyterHub and Binder will allow readers to run and modify code examples)*
- a **living document** *(content will continue to evolve, and collaboration is welcome)*
The material is mostly based on lecture notes for
[ENV 415: Climate Laboratory][env415] and [ATM 623: Climate Modeling][atm623]
at the [University at Albany][ualbany].
[To view the book online, go here][book].
The JupyterBook source and all book content (mostly [Jupyter Notebook][notebook] files)
are all in [this github repository][repo].
Much of the content is made possible by [climlab][climlab], an open-source
Python toolkit for interactive, process-oriented climate modeling.
[Brian Rose][brian] is the principle developer of climlab as well as the author of this book.
The contents of this book are licensed for free and open consumption under the following license:
[Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/)
## How to contribute or modify the book
The [source repository on github][repo] contains everything you need to build your own local version of the book.
From a local clone of the source, set up a self-contained conda environment with
```
conda env create --file environment.yml
conda activate climlab-courseware
```
This environment contains all dependencies for *both* building the book and running all the code in the book.
To build a local copy of the book, do this from the source root
```
jupyter-book build .
```
You will then find the built book in `_build/html/`, which you can open in a web browser e.g. with
```
open _build/html/index.html
```
Note that building the book creates the html from the `*.md` and `*.ipynb` sources, but does ***not*** re-run the notebooks. When building the book, we assume that all notebooks are already up-to-date!
*(You can change this behavior by modifying the `execute_notebooks` flag in `_config.yml`, but beware that some of the notebooks take a very long time to execute.)*
Anyone is welcome to suggest edits or improvements by opening pull requests on the [github repository][repo]. If you are editing any code in a notebook, please make sure you execute the modified notebook cleanly before submitting the PR.
## How is the book published
[The book][book] is just the rendered html that results from running `jupyter-book build`. A new build is triggered on GitHub Actions whenever the sources are updated on the [github repository][repo], and the successful build is deployed to the `gh-pages` branch of the repo.
[brian]: http://www.atmos.albany.edu/facstaff/brose/index.html
[env415]: http://www.atmos.albany.edu/facstaff/brose/classes/ENV415_Spring2018/
[atm623]: http://www.atmos.albany.edu/facstaff/brose/classes/ATM623_Spring2019/
[ualbany]: https://www.albany.edu
[about]: /about
[jupyterbook]: https://jupyterbook.org
[climlab]: https://github.com/climlab/climlab
[book]: https://brian-rose.github.io/ClimateLaboratoryBook/
[repo]: https://github.com/brian-rose/ClimateLaboratoryBook
[notebook]: https://jupyter-notebook.readthedocs.io/en/stable/
[ghp-import]: https://github.com/c-w/ghp-import
[jbook-publish]: https://jupyterbook.org/publish/gh-pages.html