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

[feature] : Google Collab notebooks #987

Open
SylviaWhittle opened this issue Oct 30, 2024 · 1 comment
Open

[feature] : Google Collab notebooks #987

SylviaWhittle opened this issue Oct 30, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@SylviaWhittle
Copy link
Collaborator

SylviaWhittle commented Oct 30, 2024

Is your feature request related to a problem?

Bruker and users have requested Google Collab notebooks. They are commonly used in the field.

Describe the solution you would like.

Create some Google Collab notebooks to replace the local notebooks in this repo? Would have demos for each module? (lots of dev time likely to write this up with examples)

Describe the alternatives you have considered.

Keeping using local notebooks (easier to maintain?)

Additional context

No response

@SylviaWhittle SylviaWhittle added the enhancement New feature or request label Oct 30, 2024
@ns-rse
Copy link
Collaborator

ns-rse commented Oct 30, 2024

You, or the users who requested it, shouldn't have to do anything (or at least not much) to use the existing Notebooks in Google Colab because Colab allows you to open Notebooks from GitHub.

How to use

  1. Install the browser extension...
  1. Go to the GitHub page with the notebooks on (i.e. here and click on one (it will be rendered in GitHub).
  2. Use the browser extension and hey presto 🪄

Direct links

These could be added to a new docs/notebooks.md page if desirable.

What will need updating

The Notebooks are as noted outdated, but more fundamentally they won't have TopoStats available and so rather than instructions on installing TopoStats from PyPI they will need replacing with something along the lines of...

!pip install topostats
!pip install ipywidgets

...which should "Just Work(TM)" (I virtually never use Notebooks though so no guarantee).

I just tested it and it crashes as ipython is reinstalled not sure how to handle that, ipython is only an optional dependency under dev dependency so not sure what is pulling it in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants