SciML/Catalyst.jl

add common mistakes documentation

Ouverte

#1 316 ouverte le 8 août 2025

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Julia (81 forks)github user discovery
good first issue

Métriques du dépôt

Stars
 (525 étoiles)
Métriques de merge PR
 (Merge moyen 6j 21h) (18 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez les tutoriels existants et la structure de la documentation dans le dépôt Catalyst.jl. Identifiez où ajouter une page sur les erreurs courantes et liez la de manière visible depuis les tutoriels. Compilez les exemples fournis et tout autre piège courant issu des discussions de la communauté.
Stack technique
julia
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitJulia basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90