climatelaboratorybook
JupyterBook source for The Climate Laboratory
Science Score: 46.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
JupyterBook source for The Climate Laboratory
Basic Info
- Host: GitHub
- Owner: brian-rose
- License: other
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://brian-rose.github.io/ClimateLaboratoryBook
- Size: 358 MB
Statistics
- Stars: 122
- Watchers: 3
- Forks: 53
- Open Issues: 19
- Releases: 7
Topics
Metadata Files
README.md
The Climate Laboratory
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 MyST Markdown and JupyterBook 2, 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 allows readers to run and modify code examples) - a living document (content continues 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
myst start
Then point your web brower to http://localhost:3000 to find the built pages.
Note that building the book creates the web pages 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!
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 myst build --html. 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
- Name: Brian Rose
- Login: brian-rose
- Kind: user
- Location: Albany, NY, USA
- Company: University at Albany
- Website: http://www.atmos.albany.edu/facstaff/brose/index.html
- Twitter: BrianEJRose
- Repositories: 107
- Profile: https://github.com/brian-rose
Climate scientist, professor, and practitioner of open-source science. I use mathematical and numerical models to study climatic processes at the global scale.
GitHub Events
Total
- Create event: 27
- Release event: 3
- Issues event: 16
- Watch event: 15
- Delete event: 17
- Issue comment event: 45
- Push event: 149
- Pull request review event: 3
- Pull request event: 44
- Fork event: 8
Last Year
- Create event: 27
- Release event: 3
- Issues event: 16
- Watch event: 15
- Delete event: 17
- Issue comment event: 45
- Push event: 149
- Pull request review event: 3
- Pull request event: 44
- Fork event: 8
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Brian Rose | b****e@a****u | 251 |
| dependabot[bot] | 4****] | 56 |
| James Scott-Brown | j****s@j****m | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 45
- Total pull requests: 173
- Average time to close issues: 11 months
- Average time to close pull requests: 7 days
- Total issue authors: 3
- Total pull request authors: 3
- Average comments per issue: 1.47
- Average comments per pull request: 1.29
- Merged pull requests: 158
- Bot issues: 0
- Bot pull requests: 69
Past Year
- Issues: 13
- Pull requests: 46
- Average time to close issues: 9 days
- Average time to close pull requests: about 5 hours
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 0.23
- Average comments per pull request: 1.46
- Merged pull requests: 40
- Bot issues: 0
- Bot pull requests: 9
Top Authors
Issue Authors
- brian-rose (43)
- fbschmtt (1)
- jlpearso (1)
Pull Request Authors
- brian-rose (104)
- dependabot[bot] (69)
- phaustin (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/cache v3 composite
- actions/checkout v3 composite
- actions/upload-artifact v3 composite
- conda-incubator/setup-miniconda v2 composite
- actions/checkout v3 composite
- stefanzweifel/git-auto-commit-action v4 composite
- 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
- 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
- actions/cache v3 composite
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2 composite
- styfle/cancel-workflow-action 0.11.0 composite
- 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