Skip to content

docs: add note about selecting correct Python kernel for local tutorial runs#141

Open
Abdk4Moura wants to merge 1 commit intoGeomScale:developfrom
Abdk4Moura:docs/tutorial-kernel-note
Open

docs: add note about selecting correct Python kernel for local tutorial runs#141
Abdk4Moura wants to merge 1 commit intoGeomScale:developfrom
Abdk4Moura:docs/tutorial-kernel-note

Conversation

@Abdk4Moura
Copy link
Copy Markdown

Summary

Addresses #130.

The tutorial notebook (dingo_tutorial.ipynb) was designed for Google Colab, which can confuse users running it locally about which Python kernel/environment to select.

Changes

  • tutorials/README.md: Added a "Running tutorials locally" section with guidance on kernel selection for Jupyter Lab, Jupyter Notebook, and VS Code, plus a note about skipping Colab-specific cells.
  • tutorials/dingo_tutorial.ipynb: Inserted an inline callout note (after the "About this Colab notebook" cell) directing local users to select the correct environment and skip Colab-specific installation cells.

…al runs

Addresses GeomScale#130. The tutorial notebook was designed for Google Colab, which
can confuse users running it locally about which Python kernel to select.

- Added guidance to tutorials/README.md on kernel selection for Jupyter Lab,
  Jupyter Notebook, and VS Code
- Inserted an inline note in the notebook itself (after the 'About this
  Colab notebook' cell) directing local users to select the correct
  environment and skip Colab-specific cells
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.

1 participant