Add getting started and installation instructions to the welcome page #10
Conversation
Editing the front page to include a one-click Binder link to run the Jupyter notebooks, and steps for people to get a conda virtual environment set up locally for the EGU22 short course.
TODO revert this commit once André's notebook is finished.
Change from using bulleted list of tutorials to a more eye-catching 4-grid-panel with a teaser image for each tutorial.
Make the font consistent with the other tutorials.
There was a problem hiding this comment.
Managed to make the front-page nicer using sphinx-panels (see https://jupyterbook.org/en/stable/content/content-blocks.html#panels). Now it looks like this:
Feel free to give this PR a review. I'll start to record the 5-10min intro video using this front-page now to get a feel, but will probably finish it by tomorrow morning.
book/intro.md
Outdated
| :img-top: https://user-images.githubusercontent.com/23487320/168939109-e35c9d85-4b2d-4623-abd8-66ed1148cf21.png | ||
| ```{link-button} Mars_Maps | ||
| :text: Making some Mars maps with PyGMT |
There was a problem hiding this comment.
TODO update the thumbnail image to point to the rendered version once Andre's jupyter notebook is uploaded to the repo, see #15
|
Ok, first shot at the intro, just taking people through an outline of the course content and teaching them how to get set up on Binder or locally. 2022-05-17.23-42-55.mp4Will make another recording tomorrow morning at uni (with better lighting and a proper background) after a bit more practice. Oh, and remind myself to bump up the font size too. |
|
@weiji14 First of all the front page looks already very nice! However there is a small error in the installation instruction of the Without the |
Co-Authored-By: Leonardo Uieda <[email protected]>
Co-Authored-By: Yvonne Fröhlich <[email protected]>
|
Glad to see that people are trying out the short course already 😆 Thanks @yvonnefroehlich, I've fixed the command in 05fd568. |
| 🖱️ click on the button below to launch on regular | ||
| [Binder](https://mybinder.readthedocs.io/en/latest/index.html). | ||
|
|
||
| [](https://mybinder.org/v2/gh/GenericMappingTools/egu22pygmt/main) |
There was a problem hiding this comment.
Note to self, add another Binder and Google Colab option as backups in case too many people try to use this at once during EGU. From memory, I think there's a 50 or 100 people limit on how many BInder instances can be launched per GitHub repo.
There was a problem hiding this comment.
Might need to increase limits, am getting toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit. Form to request additional resouces for MyBinder: https://github.com/jupyterhub/mybinder.org-deploy/issues/new?assignees=&labels=impact&template=request_resources.md. Looking at a few issues, they may be stretched on funding recently...
There was a problem hiding this comment.
Have added a backup Pangeo Binder link in 1059390. Haven't got the bandwidth to do Google Colab but maybe someone can work on it in a separate PR.
Co-authored-by: Max Jones <[email protected]>
|
For completeness, here's the final recording of the intro video 🎉 egu22pygmt_intro.mp4Have already stitched the 1 intro + 4 tutorial videos together, and it just fits under 1hr 30min (let's pretend I didn't have to re-record the intro too many times). Tried doing 1080p60fps but that produced a 7GB file so no go. Did 1080p30fps and that came down to 4GB. Decided to try uploading that 4GB version but the upload seemed to stop halfway (wifi at home not strong enough). I'm doing 1080p23.98fps now and seeing if that can cut the size. Few more hours to go |
|
Do you want me to see what I get with handbrake? That's the tool I've used for processing community meeting videos |
Too late, I've emailed the video in already (1080p23.8fps). It's 3.3GB though, let's just hope they're lenient enough. |
Sounds good, thanks for processing the video! Also, great job on the intro! it's fantastic 🎉 |
|
@weiji14 thank you for all the work you've done on this! The intro does look really good. We can upload higher resolution videos to YouTube later since EGU had this silly restriction. |
Editing the front page to include a one-click Binder link to run the Jupyter notebooks, and steps for people to get a conda virtual environment set up locally for the AGU24 pre-conference workshop. Based on EGU22 short course at GenericMappingTools/egu22pygmt#10.
…#12) * Add getting started and installation instructions to the welcome page Editing the front page to include a one-click Binder link to run the Jupyter notebooks, and steps for people to get a conda virtual environment set up locally for the AGU24 pre-conference workshop. Based on EGU22 short course at GenericMappingTools/egu22pygmt#10. * Add sphinx-design cards with tutorial titles, authors and tags Adding the 6 main tutorials as sphinx-design cards in a 3x2 grid. Each card has the tutorial title, author(s), and tags/badges. The tags hint at which libraries/methods will be covered, and also the datasets that are used. * Add thumbnail figures for Tutorials 1, 2, 3, 6 * Update links to tutorial notebooks/documents * Refresh badge tags for all tutorials Sort alphabetically, change `bdg-info` to `bdg-success` for more differentiation (also, unsure why primary and info colour is the same now?), and add more tags based on new tutorial updates. * Add teaser images for Tutorial 4 and 5 Also choosing other teaser images for Tutorial 1, 2, 3. * Use only bottom part of tut04 figure Figure is too long, so just getting the bottom part only. Using a 75dpi version. * Adaptive layout to utilize vertical space more efficiently Remove the h2 heading and do some more sphinx-design grid nesting to squeeze out more vertical space for the thumbnail images. The grids are now adaptive too, and will turn from 3 columns to 1 column on narrow width screens (e.g. mobile devices). Ref: https://sphinx-design.readthedocs.io/en/sbt-theme/grids.html#nesting-grids. --------- Co-authored-by: Yvonne Fröhlich <[email protected]>
Editing the front page to include a one-click Binder link to run the Jupyter notebooks, and steps for people to get a conda virtual environment set up locally for the EGU22 short course.
Once everyone has their Jupyter notebooks on the website at https://www.generic-mapping-tools.org/egu22pygmt, I'm hoping to make a quick 5-ish minute video that will introduce PyGMT very briefly and walk through how people can navigate the Jupyter Book, click on the Binder links, etc.