search

ioos / soundcoop

This repository contains Jupyter notebooks developed by the passive acoustic community for the SoundCoop project.
BSD 3-Clause "New" or "Revised" License
13 stars 4 forks source link

Compatibility with non-binder environments #6

Closed cparcerisas closed 1 month ago

cparcerisas commented 1 month ago

Right now most of the notebooks (except pypam and environment) do not have the install cell - because mybinder takes care of installing the requirements.txt for us. However I think that if people want to run these notebooks somewhere else (Colab, other jupyterlab places) and have no python experience they will not know how to install this. I propose that we all add an installing cell to the notebooks with a note saying that it is not necessary to run it when on mybinder? Or at least be consistent on all the notebooks.

Or do you have other proposals? @carriecwall @carueda @danellecline @KarinaKh

cparcerisas commented 1 month ago

See progress on #8 and #7

carriecwall commented 1 month ago

@cparcerisas i was having similar thoughts last night while looking at the notebooks. an installing cell seems crucial for immediate uptake by the community since we aren't truly promoting long-term or wide spread use of mybinder as the sole environment.

cparcerisas commented 1 month ago

Great, we can decide if we think is best to have them commented (then default not installing if running without reading) or uncommented and just an explanation saying that no need to run it when using mybinder

carriecwall commented 1 month ago

My vote is uncommented with a note but am open to all options/opinions. The dimension reduction/clustering notebook similarly needs a little context for what and how data are read/loaded. If this is annoying, we can ignore my suggestion (which may have been a bad one) to put this content into a separate notebook.

cparcerisas commented 1 month ago

Yes indeed! Working on it :) Thanks for the reminder

danellecline commented 1 month ago

I propose that we all add an installing cell to the notebooks with a note saying that it is not necessary to run it when on mybinder? Or at least be consistent on all the notebooks.

That seems fine to me, considering that notebooks can be downloaded, shared, etc. or run in other environments like Colab, where it would be necessary.

danellecline commented 1 month ago

I have already added install cells to all the PBP notebooks so we are good to go on that.