SciML/Catalyst.jl

add common mistakes documentation

Aperta

#1316 aperta il 8 ago 2025

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Julia (81 fork)github user discovery
good first issue

Metriche repository

Star
 (525 stelle)
Metriche merge PR
 (Merge medio 6g 21h) (18 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina i tutorial esistenti e la struttura della documentazione nel repository Catalyst.jl. Identifica dove aggiungere una pagina sugli errori comuni e collegala in evidenza dai tutorial. Compila gli esempi forniti e eventuali altri errori comuni dalle discussioni della community.
Tech stack
julia
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitJulia basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90