SciML/JumpProcesses.jl

Add auto-alg and auto-stepper to the docs

Offen

#444 geöffnet am 16.08.2024

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (41 Forks)github user discovery
help wanted

Repository-Metriken

Stars
 (148 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 4h) (5 gemergte PRs in 30 T)

Beschreibung

https://github.com/SciML/JumpProcesses.jl/pull/351 add autoselection of 1. the stepper (SSAStepper) and 2. the SSA (Direct for small reaction networks) and other SSAs for bigger ones.

The docs and README need to be updated. We should tell the users to use the default stepper and SSA in the introductory docs, but explain how to select solvers and stepper in more advanced places (essentially, those docs do not need to change).

Contributor Guide

Research-Richtung
Aktualisieren Sie die Einführungsdokumentation und die README, um zu erwähnen, dass auto alg und auto stepper jetzt die Standardeinstellung sind, und erklären Sie in fortgeschrittenen Dokumentationsabschnitten, wie man Stepper und SSA Löser manuell auswählt.
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.
Unter 1 Stunde
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
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90