Initial Roadmap: Example notebooks

[mberz]

Description

• Notebooks for general Tasks and Application examples could get separate sections on readthedocs

General tasks

• Find best way to link between notebooks and other parts of readthedocs
• Decide: Make notebooks downloadable
• Setup myBinder.org / jupyter.org/hub / google code lab / github code spaces. Requirements
  • Read notebooks and resources from github
  • host multiple notebooks
  • No login required
  • Docker container
• Update pyfar.org or completely move to gallery as the main homepage? (Fabian)
• Add links between notebooks and to and from the documentation of other packages
• In each notebook, mention at the beginning if there are other examples that should be read first (?)

Notebooks showing simple pyfar functionality as part of the pyfar docs

• Working with Audio Objects (Fabian) Add *Working with pyfar Audio Objects* #4
• Working with Coordinates Objects (Anne) add coordinates notebook #6
• Working with Orientation Objects (Anne) add orientations notebook #14
• Plotting Data from Audio Objects (Pascal) Add notebook for plotting #23
• Reading and Writing Data to Disk
• FFT and FFT conventions (Simon) Add Fast Fourier Transform notebook #28
• Arithmetic Operations on Audio Objects (Fabian) Notebook for arithmetic operations using pyfar audio objects #10
• Filtering Signal Objects (Fabian) Pyfar filter objects #9

Notebooks implementing DSP tasks/examples/applications
(potentially put in a separate repository)

• Sweep based IR measurement (Fabian) Notebook for arithmetic operations using pyfar audio objects #10
• Audio artifacts
• Add examples from sofar Add notebook that introduces sofar and SOFA #31
• Impulse response alignment
• Loudspeaker equalization and cross-over (Marco)
• Binaural synthesis Add a notebook that shows a basic binaural synthesis #24
• Reverberation time (Marco)

Notebooks for the application gallery

• Overview of Filter Types (Fabian) Add notebook for pyfar filter types #16

Final touches on Homepage

• Sort notebooks
• CC-BY logo in Notebooks not found (maybe must be added to static) CC-BY logo in Notebooks added static #46
• Switch for dar/light mode went away (probably edit conf.py)
• Insert blank lines to unify layout of short package descriptions
• Add image for coming next
• Change number of colums to 3 or less (see mobile view) Adjust grid depending on screen size #36
• Add QR Code with the final link for the DAGA Notebook Add qr code and fix text to workshop jupyter link #47

[mberz]

@f-brinkmann The logo is directly included from the CC homepage. It seems, that VSCode is sometimes messing that up. On binder and readthedocs, this issue does not seem to persist.