Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup Jupyter Book #1

Closed
wants to merge 7 commits into from
Closed

Setup Jupyter Book #1

wants to merge 7 commits into from

Conversation

maxrjones
Copy link
Member

Following the discussion at https://forum.generic-mapping-tools.org/t/proposal-creating-a-separate-gmt-tutorial-page/2831/11, this PR sets up a jupyter book to host material for the 2022 GMT for Geodesy UNAVCO short course.

Based on GenericMappingTools/egu22pygmt#3.

- jupyterlab=3.4.0
- python=3.9
# Optional dependencies
- jupyter-book=0.12.3
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a note that jupyter-book released 0.13.0 yesterday (https://github.com/executablebooks/jupyter-book/releases/tag/v0.13). They've migrated from sphinx-panels to sphinx-design, so you would need to change the cards in intro.md. Up to you of course whether to do the migration.

Suggested change
- jupyter-book=0.12.3
- jupyter-book=0.13.0

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I will leave this comment open for now and address it as a separate issue after the initial PR due to time restrictions.

@maxrjones
Copy link
Member Author

Preview is live at https://www.generic-mapping-tools.org/gmt-for-geodesy. @GenericMappingTools/gmt-workshop-leaders, please provide feedback about using this site structure for the GMT for geodesy workshop. Currently there's little content, but all the existing bash scripts in https://github.com/GenericMappingTools/2021-unavco-course could be made into Jupyter Notebooks if we want to use this structure.

Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

# Only run this when the main branch changes
on:
# Uncomment the 'pull_request' line below to manually re-build Jupyter Book
pull_request:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to comment this line before merging into main branch.

Suggested change
pull_request:
# pull_request:

@Esteban82
Copy link
Member

I have the habit of adding a number as a prefix to the folder names (e.g. 01_introduction) so that the folders are automatically sorted. I suggest doing the same with the course material. It may be useful for students. Here an example.

For example, for the 2021 unavco course, the names would be:

  • 00_bash
  • 01_basics
  • 02_line_symbols
  • 03_grids, ...

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@maxrjones
Copy link
Member Author

I have the habit of adding a number as a prefix to the folder names (e.g. 01_introduction) so that the folders are automatically sorted. I suggest doing the same with the course material. It may be useful for students. Here an example.

Sounds good! I am not sure if or where the current first-figure example will fit into the book, so I will add the numbers at the same time as the other materials.

@seisman
Copy link
Member

seisman commented Jul 1, 2022

I'm closing this PR because we won't use Jupyter Notebook in this workshop.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants