Skip to content

Commit 73a24af

Browse files
authored
Merge pull request #1 from Christian-Kofi-Okyere/main
Converted files to work with myst
2 parents 1f067ad + e25da3a commit 73a24af

File tree

6 files changed

+102
-82
lines changed

6 files changed

+102
-82
lines changed

._toc.yml.bak

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
format: jb-book
2+
root: README
3+
parts:
4+
- caption: Preamble
5+
chapters:
6+
- file: notebooks/how-to-cite
7+
- caption: Introduction
8+
chapters:
9+
- file: notebooks/notebook-template
10+
- file: notebooks/00_geosat_explaining_steps
11+
- file: notebooks/01_geosat_ABI_GOES_east
12+
- file: notebooks/01_geosat_GOESR
13+
- file: notebooks/02_geosat_ABI_GOES_west
14+
- file: notebooks/03_geosat_AHI_HIMAWARI
15+
- file: notebooks/04_geosat_AMI_GK2A
16+
- file: notebooks/99_auxiliar_dowloading

.github/workflows/deploy.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# This file was created automatically with `myst init --gh-pages` 🪄 💚
2+
# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
3+
4+
name: MyST GitHub Pages Deploy
5+
on:
6+
push:
7+
# Runs on pushes targeting the default branch
8+
branches: [main]
9+
env:
10+
# `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
11+
# E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
12+
# If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`.
13+
BASE_URL: /${{ github.event.repository.name }}
14+
15+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
21+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
22+
concurrency:
23+
group: 'pages'
24+
cancel-in-progress: false
25+
jobs:
26+
deploy:
27+
environment:
28+
name: github-pages
29+
url: ${{ steps.deployment.outputs.page_url }}
30+
runs-on: ubuntu-latest
31+
steps:
32+
- uses: actions/checkout@v4
33+
- name: Setup Pages
34+
uses: actions/configure-pages@v3
35+
- uses: actions/setup-node@v4
36+
with:
37+
node-version: 18.x
38+
- name: Install MyST Markdown
39+
run: npm install -g mystmd
40+
- name: Build HTML Assets
41+
run: myst build --html
42+
- name: Upload artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: './_build/html'
46+
- name: Deploy to GitHub Pages
47+
id: deployment
48+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,4 +143,6 @@ notebooks/Downloaded_data/.DS_Store
143143
notebooks/Downloaded_data/ABI-L1b-RadF/.DS_Store
144144
notebooks/.DS_Store
145145
notebooks/Downloaded_data/ABI-L1b-RadC/.DS_Store
146-
notebooks/Output_data/*
146+
notebooks/Output_data/*
147+
# MyST build outputs
148+
_build

_config.yml

Lines changed: 0 additions & 80 deletions
This file was deleted.

environment.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ dependencies:
88
- xarray
99
- satpy
1010
- matplotlib
11-
- pandas
11+
- pandas
12+
- mystmd

myst.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
version: 1
2+
extends:
3+
- https://raw.github.com/projectpythia-mystmd/pythia-config/main/pythia.yml
4+
project:
5+
title: Geostationary Cookbook
6+
authors:
7+
- name: Project Pythia Community
8+
url: https://projectpythia.org/
9+
github: https://github.com/projectpythia-mystmd/geostationary-cookbook
10+
copyright: '2024'
11+
toc:
12+
- file: README.md
13+
- title: Preamble
14+
children:
15+
- file: notebooks/how-to-cite.md
16+
- title: Introduction
17+
children:
18+
- file: notebooks/notebook-template.ipynb
19+
- file: notebooks/00_geosat_explaining_steps.ipynb
20+
- file: notebooks/01_geosat_ABI_GOES_east.ipynb
21+
- file: notebooks/01_geosat_GOESR.ipynb
22+
- file: notebooks/02_geosat_ABI_GOES_west.ipynb
23+
- file: notebooks/03_geosat_AHI_HIMAWARI.ipynb
24+
- file: notebooks/04_geosat_AMI_GK2A.ipynb
25+
- file: notebooks/99_auxiliar_dowloading.ipynb
26+
jupyter:
27+
binder:
28+
repo: projectpythia-mystmd/geostationary-cookbook
29+
site:
30+
options:
31+
logo: notebooks/images/logos/pythia_logo-white-rtext.svg
32+
folders: true
33+
template: book-theme

0 commit comments

Comments
 (0)