SciML/Catalyst.jl

add common mistakes documentation

Offen

#1.316 geöffnet am 08.08.2025

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (81 Forks)github user discovery
good first issue

Repository-Metriken

Stars
 (525 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 6T 21h) (18 gemergte PRs in 30 T)

Beschreibung

There are certain mistakes / misunderstandings that seem to commonly arise for newer users. We should add a common mistakes page and link it prominently from the tutorials.

Examples include

  1. Using @species and @parameters outside of @reaction_network and not understanding that these are actually completely unconnected.
  2. Similarly for defining t outside of @reaction_network.
  3. Using interpolation when it isn't needed (or if it is needed not using it sufficiently in that interpolation of only expressions but not external variables/species ends up being used which is like point 1. above).
  4. Callback and VariableRateJump saving controls, see https://discourse.julialang.org/t/memory-issues-for-long-ssa-simulations-with-mass-action-jumps/133530

Contributor Guide

Research-Richtung
Überprüfe die vorhandenen Tutorials und die Dokumentationsstruktur im Catalyst.jl Repository. Identifiziere, wo eine Seite mit häufigen Fehlern hinzugefügt werden soll, und verlinke sie prominent von den Tutorials aus. Stelle die gegebenen Beispiele und weitere häufige Fallstricke aus Community Diskussionen zusammen.
Tech Stack
julia
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJulia basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90