Pyfar Tutorial Videos

Open
#174 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Active
Tech stack
python

Research direction

Start by reviewing the example notebooks that are proposed as the basis for the tutorials. Use the listed video topics and planning checklist to define the scope, participants, schedule, and funding needs; done means the tutorial list and production plan are agreed.

Written by the indexing model from the issue text.

Description

Idea
  • Produce tutorial videos based on example notebooks to post on youtube
  • Target audience: students and researchers in acoustics
  • Produce short and focused videos (e.g. one for signal and one for filters instead of one introducing multiple aspects at once)
  • Organize a 2-3 day retreat in spring 2027 to produce the videos at TU Berlin with the help of the Team digit (Video studio with green screen and light board available)
  • Get funding from DEGA or EAA
List of possible videos
  1. Intro-video for the pyfar ecosystem:
  • multiple open source and cross-insitutue packages
  • super short intro for each package
  • installation and trouble shooting
  • contributing
  1. Working with Audio Objects (with link to FFT and arithmetics notebook)4. Plotting and interactive plots
  2. Filtering
  3. RIR measurement
  4. RIR parameters
  5. Coordinates and Rotation
  6. Binaural synthesis
  7. ...?
Tips from TUB team digit
  • Have rather short videos up to 10 minutes (more might be fine for our target audience)
  • Prepare a story board in advance
  • Add interactive aspects, e.g.
    • small task beyond what is shown in the notebook at the middle/end of a tutorial
    • suggestions for further tutorials
ToDo
  • Decide on the idea: We want to do this
  • Decide on date: Roughly after DAGA, either late March or in April/May
  • Secure funding
  • Finalize list of tutorials
  • Persons interested in doing tutorials: Johannes, Anton, Fabian, Hanna (maybe)
  • ...
Dominant language
Python
Stars
3
Forks
2
Avg merge
3d 23h
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyfar/gallery

All issues in pyfar/gallery

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.