-
Notifications
You must be signed in to change notification settings - Fork 10
Add getting started and installation instructions to the welcome page #10
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
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
f2ca8ef
Add getting started and installation instructions to the welcome page
weiji14 bdc1cca
Merge branch 'main' into doc/welcome-page
weiji14 f584d31
Temporarily trigger jupyter book build on CI
weiji14 e6d4aed
Use list of tutorials and authors instead of tableofcontents
weiji14 f161162
Temporary commit to show Mars Maps tutorial on sidebar
weiji14 db97856
Merge branch 'main' into doc/welcome-page
weiji14 2e6e540
Use sphinx-panels with thumbnails of tutorials
weiji14 3d42fdc
Fix thumbnail image links
weiji14 40fa47e
Remove bold heading from LiDAR tutorial
weiji14 72996fc
Fix incorrect link
weiji14 f0592ac
Modify heading to be title of workshop
weiji14 05fd568
Fix conda virtual environment creation command
weiji14 8e775b8
Put in more emojis on the front sections
weiji14 3a8c1db
Remove André's middle name
weiji14 3f8a2b9
Temporarily use gke.mybinder.org
weiji14 f9b3fae
Merge branch 'main' into doc/welcome-page
weiji14 46dbdc2
Use relative link to Mars Maps image
weiji14 5e0006b
Revert "Temporarily trigger jupyter book build on CI"
weiji14 414c38c
Remove Mars_Maps.md and revert gke.mybinder.org workaround
weiji14 1059390
Add note about using Pangeo Binder as a backup to regular mybinder
weiji14 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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,11 +1,131 @@ | ||
# Welcome to your Jupyter Book | ||
# 🌍 Crafting beautiful maps with PyGMT | ||
|
||
This is a small sample book to give you a feel for how book content is | ||
structured. | ||
It shows off a few of the major file types, as well as some sample content. | ||
It does not go in-depth into any particular topic - check out [the Jupyter Book documentation](https://jupyterbook.org) for more information. | ||
## Welcome to the EGU22 PyGMT short course 🥳 | ||
|
||
Check out the content pages bundled with this sample book to see more. | ||
This Jupyter book 📖 contains [PyGMT](https://www.pygmt.org/v0.6.1) tutorials | ||
for producing maps 🗺️ and doing geospatial data processing 🌐 | ||
|
||
```{tableofcontents} | ||
````{panels} | ||
:column: col-3 align-items-center p-2 | ||
:body: text-center | ||
|
||
--- | ||
:img-top: _images/first-figure_49_0.png | ||
```{link-button} first-figure | ||
:text: Anatomy of a PyGMT figure | ||
:type: ref | ||
``` | ||
by [Leonardo Uieda](https://orcid.org/0000-0001-6123-9515) | ||
|
||
--- | ||
:img-top: _images/ecosystem_13_1.png | ||
```{link-button} ecosystem | ||
:text: Integration with the scientific Python ecosystem 🐍 | ||
:type: ref | ||
``` | ||
by [Max Jones](https://orcid.org/0000-0003-0180-8928) | ||
|
||
--- | ||
:img-top: _images/mars_maps_11_0.png | ||
```{link-button} Mars_Maps | ||
:text: Making some Mars maps with PyGMT | ||
:type: ref | ||
``` | ||
by [André Belém](https://orcid.org/0000-0002-8865-6180) | ||
|
||
--- | ||
:img-top: _images/lidar_to_surface_36_0.png | ||
```{link-button} lidar_to_surface | ||
:text: LiDAR Point clouds to 3D surfaces ✨➡️🏔 | ||
:type: ref | ||
``` | ||
by [Wei Ji Leong](https://orcid.org/0000-0003-2354-1988) | ||
|
||
```` | ||
|
||
Each tutorial is rendered on this website for easy viewing 👀, but they are all | ||
Jupyter notebooks designed to be ran interactively 💫. See the instructions | ||
below on how you can start running the tutorials in no time! 🚀 | ||
|
||
# 🌠 Quickstart | ||
|
||
To run these notebooks in an interactive Jupyter session online, | ||
🖱️ 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) | ||
|
||
Alternatively, you can go to a specific tutorial page, hover over the rocket 🚀 | ||
icon on the top right, and click 'Binder'. | ||
|
||
:::{note} | ||
If you see an error like `toomanyrequests: You have reached your pull rate | ||
limit`, you can try this Pangeo Binder link instead as a backup, though it | ||
will require a [GitHub account](https://github.com/signup) to work: | ||
|
||
[](https://aws-uswest2-binder.pangeo.io/v2/gh/GenericMappingTools/egu22pygmt/main) | ||
::: | ||
|
||
# 💻 Running the notebooks locally | ||
|
||
If you prefer to run the 🧑🏫 tutorials with a local installation of PyGMT, then | ||
follow along! For this EGU22 short course, we recommend creating a virtual | ||
conda environment and installing the 🐍 Python libraries inside. | ||
|
||
:::{tip} For users comfortable with using `git`, feel free to ⬇️ download or | ||
clone the repository containing the short course materials directly using | ||
`git clone https://github.com/GenericMappingTools/egu22pygmt.git` | ||
::: | ||
|
||
Here's the instructions to install the `egu22pygmt` environment: | ||
|
||
1. Ensure that you have the | ||
[`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/index.html) | ||
package manager installed (e.g. via | ||
[`miniconda`](https://docs.conda.io/en/latest/miniconda.html) or | ||
[Anaconda](https://www.anaconda.com/products/distribution)). | ||
You can also use [`mamba`](https://mamba.readthedocs.io/en/latest/installation.html#fresh-install) | ||
which tends to be a ⚡ faster alternative. | ||
|
||
2. Make a folder called 'egu22pygmt'. This will be where you will put all the | ||
Jupyter notebooks and data files 🗃️ used in the short course. | ||
|
||
3. Download a copy of the 'environment.yml' file which contains a 📄 list of | ||
dependencies required to run the tutorials in this short course. Get it at | ||
https://github.com/GenericMappingTools/egu22pygmt/blob/main/environment.yml. | ||
|
||
4. Run the following commands on the 🧑💻 command-line to create the virtual | ||
environment | ||
|
||
```bash | ||
cd /path/to/egu22pygmt | ||
conda env create --name egu22pygmt --file environment.yml | ||
``` | ||
|
||
5. Once the installation is completed 🏁, launch | ||
[Jupyter Lab](https://jupyterlab.readthedocs.io) as follows: | ||
|
||
```bash | ||
conda activate egu22pygmt | ||
jupyter lab | ||
``` | ||
|
||
This should open up a page in your default browser. If not, you can click | ||
and open the 🔗 link that says `http://localhost:8888/lab?token=...` in your | ||
command-line terminal and this will will take you to the Jupyter Lab page. | ||
|
||
6. Download the Jupyter notebook(s) you want to run (e.g. | ||
https://www.generic-mapping-tools.org/egu22pygmt/first-figure.html) using | ||
either the download button on the ↗️ top right (select '.ipynb') or from | ||
GitHub at https://github.com/GenericMappingTools/egu22pygmt/tree/main/book. | ||
Make sure to put the *.ipynb file(s) inside of the 'egu22pygmt' folder. | ||
|
||
7. Open the Jupyter notebook in the left-pane file browser, e.g. by | ||
🖱️ double-clicking on `first-figure.ipynb`. You are now ready to run through | ||
the course materials 🎉! | ||
|
||
```{note} | ||
If you're intending to use PyGMT in another project outside of this course, | ||
please follow the official installation instructions at | ||
https://www.pygmt.org/latest/install.html | ||
``` |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.