A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

The Climate Laboratory

A hands-on approach to climate physics and climate modeling.
https://github.com/brian-rose/climatelaboratorybook

Category: Sustainable Development
Sub Category: Education

Keywords

climate climate-model jupyter open-textbooks python

Keywords from Contributors

archiving measur transforms animals optimize conversion observation projection generic compose

Last synced: about 19 hours ago
JSON representation

Repository metadata

JupyterBook source for The Climate Laboratory

README.md

The Climate Laboratory

DOI
Deploy Book
Link Checker

A hands-on approach to climate physics and climate modeling

By Brian E. J. Rose, University at Albany

About the book

This book is powered by 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 and ATM 623: Climate Modeling
at the University at Albany.

To view the book online, go here.
The JupyterBook source and all book content (mostly Jupyter Notebook files)
are all in this github repository.

Much of the content is made possible by climlab, an open-source
Python toolkit for interactive, process-oriented climate modeling.
Brian Rose 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)

How to contribute or modify the book

The source repository on github 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. 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 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, and the successful build is deployed to the gh-pages branch of the repo.


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 281
Total Committers: 3
Avg Commits per committer: 93.667
Development Distribution Score (DDS): 0.196

Commits in past year: 20
Committers in past year: 2
Avg Commits per committer in past year: 10.0
Development Distribution Score (DDS) in past year: 0.25

Name Email Commits
Brian Rose b****e@a****u 226
dependabot[bot] 4****] 53
James Scott-Brown j****s@j****m 2

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 32
Total pull requests: 131
Average time to close issues: 9 months
Average time to close pull requests: 9 days
Total issue authors: 3
Total pull request authors: 4
Average comments per issue: 1.66
Average comments per pull request: 1.32
Merged pull request: 124
Bot issues: 0
Bot pull requests: 58

Past year issues: 2
Past year pull requests: 22
Past year average time to close issues: N/A
Past year average time to close pull requests: about 3 hours
Past year issue authors: 2
Past year pull request authors: 2
Past year average comments per issue: 0.0
Past year average comments per pull request: 1.68
Past year merged pull request: 22
Past year bot issues: 0
Past year bot pull requests: 6

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/brian-rose/climatelaboratorybook

Top Issue Authors

  • brian-rose (30)
  • fbschmtt (1)
  • jlpearso (1)

Top Pull Request Authors

  • brian-rose (71)
  • dependabot[bot] (58)
  • phaustin (1)
  • helgehr (1)

Top Issue Labels

Top Pull Request Labels

  • dependencies (58)

Dependencies

.github/workflows/build-book.yaml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • conda-incubator/setup-miniconda v2 composite
.github/workflows/delete_preview.yaml actions
  • actions/checkout v3 composite
  • stefanzweifel/git-auto-commit-action v4 composite
.github/workflows/deploy-book.yaml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite
  • jwalton/gh-find-current-pr v1 composite
  • peaceiris/actions-gh-pages v3.9.1 composite
  • styfle/cancel-workflow-action 0.11.0 composite
.github/workflows/deploy-preview.yaml actions
  • actions/checkout v3 composite
  • actions/github-script v6 composite
  • dawidd6/action-download-artifact v2.24.3 composite
  • peaceiris/actions-gh-pages v3.9.1 composite
  • peter-evans/create-or-update-comment v2 composite
  • peter-evans/find-comment v2 composite
.github/workflows/link-checker.yaml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite
  • styfle/cancel-workflow-action 0.11.0 composite
environment.yml conda
  • cartopy
  • climlab >=0.7.11
  • ffmpeg
  • jupyter
  • jupyter-book
  • matplotlib
  • metpy
  • nc-time-axis
  • netcdf4
  • numba >=0.43.1
  • numpy
  • python 3.10.*
  • sympy
  • xarray

Score: 5.966146739123692