SciML/JumpProcesses.jl

Add auto-alg and auto-stepper to the docs

Open

#444 opened on Aug 16, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Julia (41 forks)github user discovery
help wanted

Repository metrics

Stars
 (148 stars)
PR merge metrics
 (Avg merge 2d 4h) (5 merged PRs in 30d)

Description

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 direction
Update the introductory docs and README to mention that auto alg and auto stepper are now the default, and explain how to manually select steppers and SSA solvers in advanced documentation sections.
Tech stack
julia
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90