FEniCS/dolfinx

Restructure demos into more functions where appropriate

Open

#3,076 opened on Feb 27, 2024

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)C++ (255 forks)auto 404
demogood first issue

Repository metrics

Stars
 (1,158 stars)
PR merge metrics
 (PR metrics pending)

Description

Most demos (C++ and Python) have a flat structure. This is fine for simple problems, but I see time and time again that users model their more extensive solvers on the demos and create single function (C++) / flat script (Python) demos that can be many hundreds or thousands of lines.

It would be good to review the structure of demos and refactor with more functions where appropriate. Hopefully users will then model their own codes on the more structured demos.

Contributor guide

Research direction
Examine the C++ and Python demos and identify those that are overly long. Refactor by breaking them into smaller functions, ensuring the examples remain runnable and understandable.
Tech stack
cpppython
Domain
documentation
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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
C++PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80