Skip to content

Add sweeper implementation guide without type checking infrastructure #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Add sweeper implementation guide without type checking infrastructure #612

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6c6549e
Initial plan
Copilot Feb 7, 2026
a41ba08
Add comprehensive sweeper documentation guide and enhance docstrings
Copilot Feb 7, 2026
d01c49f
Add type checking with mypy to CI pipeline and documentation
Copilot Feb 7, 2026
d2d2f39
Remove type checking infrastructure while keeping sweeper documentation
Copilot Feb 9, 2026
9078b16
Address PR review comments on sweeper guide and docstrings
Copilot Feb 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ This follows a specific OOP framework, you can look at the page on
[custom implementations](./docs/contrib/04_custom_implementations.md)
for more details. Additional guideline are also given on how to
[document the code](./docs/contrib/05_documenting_code.md) in `pySDC`.
A comprehensive guide on [sweeper implementations](./docs/contrib/08_sweeper_guide.md)
is also available to help you choose and use the right time integration method.

> 📣 Some core components (collocation matrix, $Q-\Delta$ coefficients, Lagrange barycentric interpolation)
> are implemented and developed in the [`qmat` companion package](https://github.com/Parallel-in-Time/qmat).
Expand All @@ -34,5 +36,6 @@ for more details. Additional guideline are also given on how to
5. [Custom Implementations](./docs/contrib/04_custom_implementations.md)
6. [Documenting Code](./docs/contrib/05_documenting_code.md)
7. [Adding a project](./docs/contrib/06_new_project.md)
8. [Sweeper Implementations Guide](./docs/contrib/08_sweeper_guide.md)

:arrow_left: [Back to main page](./README.md)
7 changes: 6 additions & 1 deletion docs/contrib/02_continuous_integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,12 @@ For more details, see the [automated failure handling documentation](../../.gith

## Code linting

Code style linting is performed using [black](https://black.readthedocs.io/en/stable/) and [ruff](https://docs.astral.sh/ruff/) for code syntax checking. In particular, `black` is used to check compliance with (most of) [PEP-8 guidelines](https://peps.python.org/pep-0008/).
Code quality checks are performed in the lint stage of the CI pipeline:

- **Code Formatting**: [black](https://black.readthedocs.io/en/stable/) ensures compliance with (most of) [PEP-8 guidelines](https://peps.python.org/pep-0008/)
- **Code Linting**: [ruff](https://docs.astral.sh/ruff/) checks for code syntax issues, potential bugs, and style violations

Both tools run on Python 3.13 and check the `pySDC` package.

Those tests are conducted for each commit (even for forks), but you can also run it locally in the root folder of `pySDC` before pushing any commit :

Expand Down
Loading
Loading