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

Add getting started and installation instructions to the welcome page #12

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Nov 14, 2024

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.

Screenshot

image

TODO:

  • Adding quickstart binder button and installation instructions
  • Add sphinx-design cards in 3x2 grid layout for the 6 tutorials
  • Include thumbnails of the best looking figure in each tutorial (do after all tutorials are ready)
  • etc

References:

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.
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.
@weiji14 weiji14 self-assigned this Nov 14, 2024
{bdg-secondary-line}`japan_quakes`
{bdg-info}`pandas`
{bdg-info}`geopandas`
{bdg-info-line}`airbnb`
Copy link
Member

Choose a reason for hiding this comment

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

Not sure about this; I would prefer to include "choropleth map"

Suggested change
{bdg-info-line}`airbnb`
{bdg-info-line}`choropleth map`

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, I could use some advice on what tags/badges to add. My current thought process is to include:

  • bdg-primary: pygmt or gmt
  • bdg-primary-line: GMT module used (e.g. coast, plot, etc)
  • bdg-info: External library used (e.g. pandas, xarray)
  • bdg-secondary-line: GMT remote-dataset used (e.g. earth_relief, earth_age, etc)

The {bdg-info-line}`airbnb` here was intended to show external non GMT remote-datasets used, but I do agree that having AirBnB here looks weird. We could maybe add some tags for concepts being taught such as choropleth-map as you suggested, or scatterplot, etc.

Ref: color of badges/tags: https://sphinx-design.readthedocs.io/en/sbt-theme/badges_buttons.html#badges

Copy link
Member

Choose a reason for hiding this comment

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

Yep, I got your main idea behind the structure of these tags / badges and I definitely like this idea! And I think mentioning special concept / specific visualization is a good addition.

Even the file contains "airbnb" currently the column “population” is used for the choropleth-map (there are a lot of different columns / quantities in this dataset).

yvonnefroehlich

This comment was marked as off-topic.

@yvonnefroehlich yvonnefroehlich added the documentation Improvements or additions to documentation label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants