Make the 1D Kalman filter examples visible as simulations

Abierto
  • ¿Algo no está bien?
#96 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 9 días

@DevShoaib78 ya está trabajando en esto.

Desde el 31/10/2026.

  • #157 de @DevShoaib78 — abierto

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
72/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

Read src/components/localization/kalman_filter/kalman_filter_1d_pos.py and kalman_filter_1d_pos_spd.py, then check the simulation script conventions in generate_example_gallery.py and the entries in doc/EXAMPLES.md. Move the scripts and their output images into src/simulations/localization/kalman_filter_1d/, add smoke tests under test/, and regenerate pyrightconfig.json with python generate_pyrightconfig.py. Done means both simulations appear in doc/EXAMPLES.md and all tests pass.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation good first issue

Problem

src/components/localization/kalman_filter/kalman_filter_1d_pos.py and kalman_filter_1d_pos_spd.py are the easiest Kalman filter examples in the repository, a good entry point for beginners. But they live in src/components, run from their own __main__, have no test, and are not listed in doc/EXAMPLES.md. Their output images sit loose in src/simulations/localization/.

Expected fix

  • Move them to src/simulations/localization/kalman_filter_1d/ (one directory, sharing the same Title:), following the simulation script conventions (show_plot, main(), docstring template in generate_example_gallery.py)
  • Move the output images into that directory
  • Add test/test_<name>.py smoke tests
  • Regenerate pyrightconfig.json with python generate_pyrightconfig.py

Done when

They appear in doc/EXAMPLES.md after merge, and all tests pass.

Lenguaje dominante
Python
Estrellas
1.9k
Forks
313
Merge medio
9 d 10 h
PR fusionados (30 d)
7

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Sin plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ShisatoYano/AutonomousVehicleControlBeginnersGuide

Todos los issues de ShisatoYano/AutonomousVehicleControlBeginnersGuide

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.