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.

Sign up for GitHub

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

Jump to bottom

[Doc]: Add steps for setting up kernel and make conda env setup consistent across Jupyter Notebooks #647

Closed
tomvothecoder opened this issue Apr 22, 2024 · 0 comments · Fixed by #652
Closed

[Doc]: Add steps for setting up kernel and make conda env setup consistent across Jupyter Notebooks #647

tomvothecoder opened this issue Apr 22, 2024 · 0 comments · Fixed by #652
Assignees
@tomvothecoder
Labels
type: docs Updates to documentation
Milestone
FY24Q3 (4/01/24 -...

Comments

@tomvothecoder
Copy link
Collaborator

tomvothecoder commented Apr 22, 2024 •
edited
Loading

Describe your documentation update

Related to #646 (comment)

We can either 1) add a note on the notebooks to let the the user know Python3 (ipykernel) is the kernel of xcdat_notebook by default or 2) add the extra step to register the kernel in all of the notebooks, which is necessary if the tries to use the notebooks through a Jupyter instance invoked elsewhere and not xcdat_notebook.

Also we should make sure the conda env setup instructions are identical across notebooks.
@tomvothecoder tomvothecoder added the type: docs Updates to documentation label Apr 22, 2024
@tomvothecoder tomvothecoder self-assigned this Apr 22, 2024
@tomvothecoder tomvothecoder changed the title [Doc]: Add steps for setting up kernel in Jupyter Notebooks [Doc]: Add steps for setting up kernel in Jupyter Notebooks and make conda env setup consistent Apr 30, 2024
@tomvothecoder tomvothecoder changed the title [Doc]: Add steps for setting up kernel in Jupyter Notebooks and make conda env setup consistent [Doc]: Add steps for setting up kernel and make conda env setup consistent across Jupyter Notebooks Apr 30, 2024
@tomvothecoder tomvothecoder mentioned this issue May 8, 2024
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tomvothecoder tomvothecoder

Labels
type: docs Updates to documentation
Projects
xCDAT Development
Status: Done
Milestone
FY24Q3 (4/01/24 - 06/30/24)
Development

Successfully merging a pull request may close this issue.

Update notebook env setup instructions with kernel xCDAT/xcdat
1 participant
@tomvothecoder