Skip to content

Add beginner notes for running notebooks - #36

Open
LeKingArt wants to merge 1 commit into
decryptofy:mainfrom
LeKingArt:patch-1
Open

LeKingArt wants to merge 1 commit into
decryptofy:mainfrom
LeKingArt:patch-1

Conversation

@LeKingArt

Copy link
Copy Markdown

This PR adds a short beginner-focused note to the README about running SCARR notebooks with Jupyter-compatible tools.

It addresses Issue #11 by keeping the guidance general instead of making it specific only to VS Code, based on the maintainer feedback in the issue discussion.

This PR adds a short beginner-focused note to the README about running SCARR notebooks with Jupyter-compatible tools.

It addresses Issue decryptofy#11 by keeping the guidance general instead of making it specific to VS Code only, based on the maintainer feedback in the issue discussion.
@decryptofy

Copy link
Copy Markdown
Owner

Thank you for your interest in contributing to SCARR. This additional text seems a bit redundant to the text in the Install section:

To make use of Jupyter notebooks, you may want to use VS Code and its Jupyter plugin, or PyCharm, but any other option to run Jupyter notebooks should work, too.

My preference would be a separate beginner guide (referenced to in README.md but outside of it so as to not further inflate it) that covers a bit more of the needed setup to bridge the gap to running the Jupyter notebooks. This guide should also include some common pitfalls (say, a Thumbs.db or other hidden file in the .zarr directory that causes Zarr to report an incorrectly structured file).

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.

2 participants