forked from geo-smart/simple-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c847752
commit d75df3a
Showing
1 changed file
with
34 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,44 @@ | ||
# Geosmart Use Case Jupyter Book | ||
# Oceanography Jupyter Book | ||
|
||
Badges: <BR><BR> | ||
|
||
|
||
[![Deploy](https://github.com/geo-smart/use_case_template/actions/workflows/deploy.yaml/badge.svg)](https://github.com/geo-smart/use_case_template/actions/workflows/deploy.yaml) | ||
[![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://geo-smart.github.io/simple-template) | ||
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geo-smart/simple-template/HEAD?labpath=book%2Fchapters) | ||
[![GeoSMART Use Case](./book/img/use_case_badge.svg)](https://geo-smart.github.io/usecases) | ||
|
||
This repository stores a skeleton of a GeoSMART use case book.<br> | ||
|
||
1. Click "Use This Template" and name your repository | ||
My name is Rob Fatland and among other things I advocate for extensively documenting one's process. | ||
This here is how this Oceanography Book was assembled from a provided template: The Geo-Smart organization's | ||
'simple skeleton' source repository.<br> | ||
|
||
|
||
- I knew there were two templates available: The simple one (in use here) and a more comprehensive version | ||
- The website to view these (plus existing books) is [here](https://geo-smart.github.io/usecases). | ||
- From the simple template I followed the directions (4 steps) in the README | ||
- (1) Clicked "Use This Template"; named the new repository (appearing in my personal organization) **`oceanography`** | ||
- Forked main branch only (the default checked option) | ||
- I have an existing repository **`ocean`**: Will be the basis of this Jupyter book | ||
- I am starting with a blank slate here | ||
- Started editing this `README.md` to trace my steps | ||
- (2) Edited `book/_config.yml` file to reflect this fork to `my-org/oceanography` | ||
- Presumably this will get bounced back over to the geo-smart org: For a later day | ||
- (3) Settings --> Pages --> Source = GitHub Actions | ||
- To do (?): Enable github pages | ||
- (4) Edit `environment.yml` to establish a working environment | ||
- How to create a proper **`environment.yml`**? | ||
- Read up on Python and environments | ||
- Install the `conda` package manager | ||
- I use `miniconda` | ||
- I then install packages / libraries as needed | ||
- From a working (*activated*) environment: `conda env export > environment.yml` | ||
- Analogous: `pip freeze` produces `requirements.txt` | ||
|
||
|
||
2. In your repository edit book/_config.yml | ||
### Remaining instructions / question | ||
|
||
3. Under your repository Settings --> Pages --> Source = GitHub Actions | ||
- Jupyter notebooks go in the books/chapters folder: One notebook per chapter; add chapter file paths to book/_toc.yml | ||
- in the github repository, enable github pages | ||
- push all changes | ||
|
||
3. Edit environment.yml, modify notebooks, and your JupyterBook will be published for you! |