search

AFM-SPM / TopoStats

An AFM image analysis program to batch process data and obtain statistics from images
https://afm-spm.github.io/TopoStats/
GNU Lesser General Public License v3.0
60 stars 11 forks source link

[feature] : Google Collab notebooks #987

Open SylviaWhittle opened 3 weeks ago

SylviaWhittle commented 3 weeks ago

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

ns-rse commented 3 weeks ago

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...
  2. Go to the GitHub page with the notebooks on (i.e. here and click on one (it will be rendered in GitHub).
  3. Use the browser extension and hey presto :magic_wand:

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.