SciML/Catalyst.jl

add common mistakes documentation

Aberta

#1.316 aberto em 8 de ago. de 2025

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Julia (81 forks)github user discovery
good first issue

Métricas do repositório

Stars
 (525 estrelas)
Métricas de merge de PR
 (Mesclagem média 6d 21h) (18 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Revise os tutoriais existentes e a estrutura da documentação no repositório Catalyst.jl. Identifique onde adicionar uma página de erros comuns e vincule a de forma proeminente nos tutoriais. Compile os exemplos fornecidos e quaisquer outras armadilhas comuns de discussões da comunidade.
Pilha de tecnologia
julia
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitJulia basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90