Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Restructure user guide into focused topic notebooks

Aperta
  • Qualcosa non va?
#495 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@schroedtert ci sta già lavorando.

Dal 28/10/2025.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

documentation

Summary

Replace the monolithic user guide notebook with a set of focused, topic-specific notebooks and a landing page that explains the overall workflow — including a flowchart — and links to the fundamental diagram notebooks as an end-to-end showcase.

Background / Context

The current user guide is a single large notebook covering all functionality, making it hard to navigate and maintain. Splitting it into focused notebooks improves discoverability and makes it easier to extend. The fundamental diagram notebooks already exist but are not surfaced in the user guide — adding them provides a concrete example of how the individual methods combine into a real analysis.

Technical Details

  • Notebooks should be moved to docs/source/notebooks/ so Sphinx can reference them directly without relative path workarounds
  • The landing page (docs/source/user_guide/index.rst) should describe the workflow and embed a flowchart
  • Proposed notebook structure reflecting the typical analysis workflow:
    1. Measurement Setup — define geometry and measurement regions
    2. Load Trajectories — import data from various sources
    3. Preprocessing — (optional) filter and clean data
    4. Analysis — compute density, speed, flow, and other metrics
  • A short notebook explaining how to use pandas for merging, saving (What to do with the results? section)
  • The fundamental diagram notebooks serve as the end-to-end showcase tying the above steps together
  • The old monolithic user_guide.ipynb should be retired once content is distributed

Acceptance Criteria

  • User guide landing page exists with a flowchart visualising the analysis workflow
  • User guide is split into the four topic notebooks listed above
  • Each notebook is self-contained and can be followed independently
  • Fundamental diagram notebooks are linked from the user guide as an end-to-end showcase
  • Add explanations to Fundamental diagram notebook
  • Old monolithic user guide notebook is removed
  • ReadTheDocs build renders all notebooks and the landing page correctly
Lingua principale
Pascal
Stelle
35
Fork
18
Merge medio
1g 14h
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PedestrianDynamics/PedPy

Tutte le issue di PedestrianDynamics/PedPy

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.