search

AlonKellner / waloviz

An open source interactive spectrogram audio player, primarily based on bokeh and the holoviz stack (wav+holoviz=waloviz)
MIT License
65 stars 1 forks source link

Generalize Installation Instructions #10

Closed MarcSkovMadsen closed 3 months ago

MarcSkovMadsen commented 3 months ago

The current installation instruction for ffmpeg (apt-get install ffmpeg) can only be followed by users 1) using linux 2) having the rights to install apt-get packages. That is not always the case as users might be using other OS's or be limited in what they can install.

Please improve the installation instructions to support more users.

For example by providing alternative conda installation instructions or making seperate linux, macos and windows installation instructions.

AlonKellner commented 3 months ago

Hmmm that's a tricky one, even torchaudio's explanation is a bit convoluted to my taste: https://pytorch.org/audio/stable/installation.html#optional-dependencies

I can just replace the apt-get install ffmpeg with conda install -c conda-forge 'ffmpeg<7' which is better in terms of compatibility but is not native to non conda users, @MarcSkovMadsen what do you think?

MarcSkovMadsen commented 3 months ago

I would recommend having a Tab with pip and conda instructions seperately. With pip you use the current instructions, maybe explaining that apt-get will only work for linux users, maybe linking to windows/ macos installation instructions.

With conda you can install everything using conda I believe.

AlonKellner commented 3 months ago

This was solved with #13, what I ended up doing was just check if it's installed in the landing pages, if not there is a guide with conda, brew and apt-get commands, and if that fails I linked to an external multiple platform installation guide. That seems good enough for me, I'm closing this issue :)

MarcSkovMadsen commented 3 months ago

Great work. Thanks.