From 6c38eb2f87b656cabed58befa6c2627d9683dd75 Mon Sep 17 00:00:00 2001 From: robfatland Date: Thu, 22 Aug 2024 17:44:08 -0700 Subject: [PATCH] Abernathy! --- book/_toc.yml | 31 +++---- book/chapters/1.0about.ipynb | 80 ++++++++++++++++++ ...eanscience.ipynb => 1.1oceanscience.ipynb} | 2 +- ...ipelargosy.ipynb => 1.2epipelargosy.ipynb} | 4 +- ...and_coincidence.ipynb => 1.3anomaly.ipynb} | 0 .../{annotation.ipynb => 1.4annotation.ipynb} | 0 book/chapters/{argo.ipynb => 1.5argo.ipynb} | 4 +- .../{glodap.ipynb => 1.6glodap.ipynb} | 0 book/chapters/{modis.ipynb => 1.7modis.ipynb} | 0 book/chapters/{roms.ipynb => 1.8roms.ipynb} | 0 ...ectrophotometer.ipynb => 1.9spectra.ipynb} | 0 book/chapters/{data.ipynb => 2.1data.ipynb} | 0 .../{dataloader.ipynb => 2.2dataloader.ipynb} | 0 ...calnotes.ipynb => 2.3technicalnotes.ipynb} | 0 ...mentation.ipynb => 2.4documentation.ipynb} | 0 .../{issues.ipynb => 2.5issues.ipynb} | 0 book/chapters/2.6resources.ipynb | 39 +++++++++ book/chapters/about.ipynb | 82 ------------------- 18 files changed, 141 insertions(+), 101 deletions(-) create mode 100644 book/chapters/1.0about.ipynb rename book/chapters/{oceanscience.ipynb => 1.1oceanscience.ipynb} (99%) rename book/chapters/{epipelargosy.ipynb => 1.2epipelargosy.ipynb} (99%) rename book/chapters/{anomaly_and_coincidence.ipynb => 1.3anomaly.ipynb} (100%) rename book/chapters/{annotation.ipynb => 1.4annotation.ipynb} (100%) rename book/chapters/{argo.ipynb => 1.5argo.ipynb} (99%) rename book/chapters/{glodap.ipynb => 1.6glodap.ipynb} (100%) rename book/chapters/{modis.ipynb => 1.7modis.ipynb} (100%) rename book/chapters/{roms.ipynb => 1.8roms.ipynb} (100%) rename book/chapters/{spectrophotometer.ipynb => 1.9spectra.ipynb} (100%) rename book/chapters/{data.ipynb => 2.1data.ipynb} (100%) rename book/chapters/{dataloader.ipynb => 2.2dataloader.ipynb} (100%) rename book/chapters/{technicalnotes.ipynb => 2.3technicalnotes.ipynb} (100%) rename book/chapters/{documentation.ipynb => 2.4documentation.ipynb} (100%) rename book/chapters/{issues.ipynb => 2.5issues.ipynb} (100%) create mode 100644 book/chapters/2.6resources.ipynb delete mode 100644 book/chapters/about.ipynb diff --git a/book/_toc.yml b/book/_toc.yml index b13845d..ca3293f 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -10,24 +10,25 @@ parts: - title: Project Pythia Foundations url: https://foundations.projectpythia.org/landing-page.html - title: About the Geo-Smart Library - file: chapters/about + file: chapters/1.0about - caption: Ocean Data Science chapters: - - file: chapters/oceanscience - - file: chapters/epipelargosy - - file: chapters/anomaly - - file: chapters/annotation - - file: chapters/argo - - file: chapters/glodap - - file: chapters/modis - - file: chapters/roms - - file: chapters/spectrophotometer - - file: chapters/data - - file: chapters/dataloader - - file: chapters/technicalnotes - - file: chapters/documentation - - file: chapters/issues + - file: chapters/1.1oceanscience + - file: chapters/1.2epipelargosy + - file: chapters/1.3anomaly + - file: chapters/1.4annotation + - file: chapters/1.5argo + - file: chapters/1.6glodap + - file: chapters/1.7modis + - file: chapters/1.8roms + - file: chapters/1.9spectra + - file: chapters/2.1data + - file: chapters/2.2dataloader + - file: chapters/2.3technicalnotes + - file: chapters/2.4documentation + - file: chapters/2.5issues + - file: chapters/2.6resources - caption: Example diff --git a/book/chapters/1.0about.ipynb b/book/chapters/1.0about.ipynb new file mode 100644 index 0000000..14c9ce8 --- /dev/null +++ b/book/chapters/1.0about.ipynb @@ -0,0 +1,80 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": { + "tags": [] + }, + "source": [ + "[Jupyter Book](https://geo-smart.github.io/oceanography/intro.html)\n", + "[GitHub repo](https://github.com/geo-smart/oceanography)\n", + "\n", + "\n", + "# The GeoSMART Use Case Library\n", + "\n", + "\n", + "## Preamble\n", + "\n", + "These remarks consider a collection of Jupyter Books forming a digital \n", + "geoscience library. \n", + "Books in the library can be identified by the badge\n", + "[![GeoSMART Use Case](../img/use_case_badge.svg)](https://geo-smart.github.io/usecases)\n", + "\n", + "\n", + "## Contributing\n", + "\n", + "DIY Jupyter Book from template; or contribute content for integration\n", + "\n", + "\n", + "Jupyter books support executable code on some platform.\n", + "\n", + "\n", + "* Binder\n", + "* Google Colab\n", + "* Free AWS tier (smaller cloud-based examples)\n", + "\n", + "\n", + "## Creating a Jupyter Book\n", + "\n", + "\n", + "Navigate the Use Case template repository and click \"use as template\".\n", + "In the resulting repo: The `.github` folder contains github actions that will \n", + "recompile the book when revisions are submitted. There is no gh-pages branch\n", + "creation; this is automated." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.12.3" + }, + "vscode": { + "interpreter": { + "hash": "c446eef832ec964573dc49f36fd16bdbed40cbfbefbf557bc2dc78d9e7968689" + } + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/book/chapters/oceanscience.ipynb b/book/chapters/1.1oceanscience.ipynb similarity index 99% rename from book/chapters/oceanscience.ipynb rename to book/chapters/1.1oceanscience.ipynb index ee8bd84..b5914d1 100644 --- a/book/chapters/oceanscience.ipynb +++ b/book/chapters/1.1oceanscience.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "[Jupyter Book](https://geo-smart.github.io/oceanography/chapters/oceanscience.html) \n", + "[Jupyter Book](https://geo-smart.github.io/oceanography/chapters/1.1oceanscience.html) \n", "
[GitHub repo](https://github.com/geo-smart/oceanography)\n", "
[RCA Learning Site](https://interactiveoceans.washington.edu)\n", "\n", diff --git a/book/chapters/epipelargosy.ipynb b/book/chapters/1.2epipelargosy.ipynb similarity index 99% rename from book/chapters/epipelargosy.ipynb rename to book/chapters/1.2epipelargosy.ipynb index 74718a0..6101603 100644 --- a/book/chapters/epipelargosy.ipynb +++ b/book/chapters/1.2epipelargosy.ipynb @@ -11,8 +11,8 @@ "tags": [] }, "source": [ - "[Jupyter Book](https://geo-smart.github.io/oceanography/chapters/epipelargosy.html) \n", - "and [GitHub repo](https://github.com/geo-smart/oceanography).\n", + "[Jupyter Book](https://geo-smart.github.io/oceanography/chapters/1.2epipelargosy.html)
\n", + "[GitHub repo](https://github.com/geo-smart/oceanography)\n", "\n", "\n", "# Epipelargosy\n", diff --git a/book/chapters/anomaly_and_coincidence.ipynb b/book/chapters/1.3anomaly.ipynb similarity index 100% rename from book/chapters/anomaly_and_coincidence.ipynb rename to book/chapters/1.3anomaly.ipynb diff --git a/book/chapters/annotation.ipynb b/book/chapters/1.4annotation.ipynb similarity index 100% rename from book/chapters/annotation.ipynb rename to book/chapters/1.4annotation.ipynb diff --git a/book/chapters/argo.ipynb b/book/chapters/1.5argo.ipynb similarity index 99% rename from book/chapters/argo.ipynb rename to book/chapters/1.5argo.ipynb index 7c7ef98..518e47e 100644 --- a/book/chapters/argo.ipynb +++ b/book/chapters/1.5argo.ipynb @@ -5,11 +5,13 @@ "id": "respective-floating", "metadata": {}, "source": [ - "[Jupyter Book](https://geo-smart.github.io/oceanography/intro.html) and [GitHub repo](https://github.com/geo-smart/oceanography).\n", + "[Jupyter Book](https://geo-smart.github.io/oceanography/intro.html)\n", + "[GitHub repo](https://github.com/geo-smart/oceanography).\n", "\n", "\n", "# ARGO\n", "\n", + "\n", "This notebook brings ARGO drifter data into the picture.\n", "\n", "\n", diff --git a/book/chapters/glodap.ipynb b/book/chapters/1.6glodap.ipynb similarity index 100% rename from book/chapters/glodap.ipynb rename to book/chapters/1.6glodap.ipynb diff --git a/book/chapters/modis.ipynb b/book/chapters/1.7modis.ipynb similarity index 100% rename from book/chapters/modis.ipynb rename to book/chapters/1.7modis.ipynb diff --git a/book/chapters/roms.ipynb b/book/chapters/1.8roms.ipynb similarity index 100% rename from book/chapters/roms.ipynb rename to book/chapters/1.8roms.ipynb diff --git a/book/chapters/spectrophotometer.ipynb b/book/chapters/1.9spectra.ipynb similarity index 100% rename from book/chapters/spectrophotometer.ipynb rename to book/chapters/1.9spectra.ipynb diff --git a/book/chapters/data.ipynb b/book/chapters/2.1data.ipynb similarity index 100% rename from book/chapters/data.ipynb rename to book/chapters/2.1data.ipynb diff --git a/book/chapters/dataloader.ipynb b/book/chapters/2.2dataloader.ipynb similarity index 100% rename from book/chapters/dataloader.ipynb rename to book/chapters/2.2dataloader.ipynb diff --git a/book/chapters/technicalnotes.ipynb b/book/chapters/2.3technicalnotes.ipynb similarity index 100% rename from book/chapters/technicalnotes.ipynb rename to book/chapters/2.3technicalnotes.ipynb diff --git a/book/chapters/documentation.ipynb b/book/chapters/2.4documentation.ipynb similarity index 100% rename from book/chapters/documentation.ipynb rename to book/chapters/2.4documentation.ipynb diff --git a/book/chapters/issues.ipynb b/book/chapters/2.5issues.ipynb similarity index 100% rename from book/chapters/issues.ipynb rename to book/chapters/2.5issues.ipynb diff --git a/book/chapters/2.6resources.ipynb b/book/chapters/2.6resources.ipynb new file mode 100644 index 0000000..18f8e4a --- /dev/null +++ b/book/chapters/2.6resources.ipynb @@ -0,0 +1,39 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "id": "cf3937d6-7bf3-4b03-ae47-7ab0c5eef559", + "metadata": {}, + "source": [ + "# Resources\n", + "\n", + "This chapter provides some pathways for learning more about ocean science.\n", + "\n", + "\n", + "- [Introduction to Physical Oceanography by Ryan Abernathy (chapter 1)](https://rabernat.github.io/intro_to_physical_oceanography/01_ocean_bathymetry.html)\n", + "- " + ] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3 (ipykernel)", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.12.3" + } + }, + "nbformat": 4, + "nbformat_minor": 5 +} diff --git a/book/chapters/about.ipynb b/book/chapters/about.ipynb deleted file mode 100644 index 4160618..0000000 --- a/book/chapters/about.ipynb +++ /dev/null @@ -1,82 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": { - "tags": [] - }, - "source": [ - "[Jupyter Book](https://geo-smart.github.io/oceanography/intro.html) and [GitHub repo](https://github.com/geo-smart/oceanography).\n", - "\n", - "\n", - "# About the GeoSMART Use Case Library\n", - "\n", - "\n", - "### General Overview\n", - "\n", - "\n", - "Explain this family of books, link to others, explain how to contribute and purpose. Books in the library can be identified by the badge:\n", - "\n", - "\n", - "[![GeoSMART Use Case](../img/use_case_badge.svg)](https://geo-smart.github.io/usecases)\n", - "\n", - "\n", - "### Contributing Content\n", - "\n", - "\n", - "Tutorial content can be integrated into jupyterbooks in one of two ways:\n", - "* Do it yourself (use this template book and add your content)\n", - "* Provide use your content (preferably in a github repo) and we will integrate it\n", - "\n", - "\n", - "The goal is to provide executable code on some platform. The contributor can choose between:\n", - "* Binder\n", - "* Google Colab\n", - "* Free AWS (smaller cloud-based examples)\n", - "If none of the above options work for you, please contact us directly to discuss further.\n", - "\n", - "\n", - "### Technical Details\n", - "\n", - "\n", - "Creating a use case book can either be done by navigating use case template repository and clicking the \"use as template\" button.\n", - "\n", - "\n", - "The `.github` folder already contains the github actions that will handle CI/CD deployment to github pages. There is no need to create a gh-pages branch, the first run of the github actions should handle that automatically." - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3 (ipykernel)", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.12.3" - }, - "vscode": { - "interpreter": { - "hash": "c446eef832ec964573dc49f36fd16bdbed40cbfbefbf557bc2dc78d9e7968689" - } - } - }, - "nbformat": 4, - "nbformat_minor": 4 -}