patrick-kidger / patrick-kidger/diffrax

Add optional progress bar / log-to-console

Open
#87 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Python
Stars
2.1k
Forks
189
Avg merge
3d 18h
Merged PRs (30d)
1

Description

When integrating large systems, it might take a while before the solution is returned. It'd be nice if there was a verbose=False argument that would either generate a progress bar (maybe using rich) or just old-school print some stats to console after each time step is done.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests. Start by locating the solver time-step loop, then determine how an optional verbose argument should expose progress or console statistics; done means long integrations can report progress when requested without requiring it by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.