qmat

Package for the generation of coefficients used in Spectral Deferred Correction and related methods (Runge-Kutta, ...)

https://github.com/parallel-in-time/qmat

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 1 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.9%) to scientific vocabulary

Keywords

butcher-tableau collocation quadrature runge-kutta-methods spectral-deferred-corrections time-integration

Last synced: 6 months ago · JSON representation ·

Repository

Package for the generation of coefficients used in Spectral Deferred Correction and related methods (Runge-Kutta, ...)

Basic Info

Host: GitHub
Owner: Parallel-in-Time
License: bsd-2-clause
Language: Python
Default Branch: main
Homepage: https://qmat.readthedocs.io/en/latest/
Size: 4.86 MB

Statistics

Stars: 2
Watchers: 3
Forks: 3
Open Issues: 2
Releases: 20

Topics

butcher-tableau collocation quadrature runge-kutta-methods spectral-deferred-corrections time-integration

Created over 1 year ago · Last pushed 7 months ago

Metadata Files

Readme Contributing License Code of conduct Citation Security

QMat Package

qmat is a python package to generate matrix coefficients related to Collocation methods, Spectral Deferred Corrections (SDC), and more generally for Runge-Kutta methods.

It allows to generate $Q$-coefficients for multi-stages methods (equivalent to Butcher tables) :

$$ Q\text{-coefficients : } \begin{array}{c|c} \tau & Q \ \hline & w^\top \end{array} \quad \Leftrightarrow \quad \begin{array}{c|c} c & A \ \hline & b^\top \end{array} \quad\text{(Butcher table)} $$

and many different lower-triangular approximations of the $Q$ matrix, named $Q_\Delta$, which are key elements for Spectral Deferred Correction (SDC), or more general Iterated Runge-Kutta Methods.

Installation

bash pip install qmat

🔍 See more detailed instructions for conda environment, development, ...

Basic usage

📜 If you are already familiar with those concepts, you can use this package like this :

```python from qmat import genQCoeffs, genQDeltaCoeffs

Coefficients or specific collocation method

nodes, weights, Q = genQCoeffs( "Collocation", nNodes=4, nodeType="LEGENDRE", quadType="RADAU-RIGHT")

QDelta matrix from Implicit-Euler based SDC

QDelta = genQDeltaCoeffs("IE", nodes=nodes)

Butcher table of the classical explicit RK4 method

c, b, A = genQCoeffs("ERK4") ```

🔔 If you are not familiar with SDC or related methods, and want to learn more about it, checkout the latest documentation build and in particular the step by step notebook tutorials

For any contribution, please checkout out (very cool) Contribution Guidelines and the current Development Roadmap.

Projects relying on `qmat`

pySDC : Python implementation of the spectral deferred correction (SDC) approach and its flavors, esp. the multilevel extension MLSDC and PFASST.
SWEET : Shallow Water Equation Environment for Tests, Awesome! (C++).

Links

Documentation : https://qmat.readthedocs.io/
Issues Tracker : https://github.com/Parallel-in-Time/qmat/issues
Q&A : https://github.com/Parallel-in-Time/qmat/discussions/categories/q-a
Project Proposals : https://github.com/Parallel-in-Time/qmat/discussions/categories/project-proposals

Owner

Name: Parallel-in-Time (PinT) Algorithms
Login: Parallel-in-Time
Kind: organization

Website: https://www.parallel-in-time.org/
Repositories: 16
Profile: https://github.com/Parallel-in-Time

Parallel-in-Time Algorithms

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."

abstract: "Generation of Q-coefficients for Spectral Deferred Corrections (and other time-integration methods ...)"
authors: 
  - family-names: Lunet
    given-names: Thibaut
    orcid: https://orcid.org/0000-0003-1745-0780
    affiliation: "Hamburg University of Technology, Institute of Mathematics, 21073 Hamburg, Germany"
  - family-names: Baumann
    given-names: Thomas
    orcid: https://orcid.org/0000-0002-4676-7659
    affiliation: "Jülich Supercomputing Centre, Forschungszentrum Jülich GmbH, 52425 Jülich, Germany"
  - family-names: Speck
    given-names: Robert
    orcid: https://orcid.org/0000-0002-3879-1210
    affiliation: "Jülich Supercomputing Centre, Forschungszentrum Jülich GmbH, 52425 Jülich, Germany"

version: 0.1.19
doi: 10.5281/zenodo.11956479
date-released: 2025-08-20
keywords: 
  - "time integration"
  - "spectral deferred corrections"
  - collocation
  - "Runge-Kutta"
license: BSD-2-Clause
repository-code: https://github.com/Parallel-in-Time/qmat
title: "Parallel-in-Time/qmat"

GitHub Events

Total

Release event: 7
Watch event: 2
Delete event: 2
Issue comment event: 11
Push event: 45
Pull request event: 9
Fork event: 1
Create event: 9

Last Year

Release event: 7
Watch event: 2
Delete event: 2
Issue comment event: 11
Push event: 45
Pull request event: 9
Fork event: 1
Create event: 9

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 2
Average time to close issues: N/A
Average time to close pull requests: about 3 hours
Total issue authors: 0
Total pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.5
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 2
Average time to close issues: N/A
Average time to close pull requests: about 3 hours
Issue authors: 0
Pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.5
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

pancetta (2)

Pull Request Authors

brownbaerchen (7)
tlunet (3)
pancetta (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 7,784 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 28
Total maintainers: 1

pypi.org: qmat

Generation of Q-coefficients for Spectral Deferred Corrections (and other time-integration methods ...)

Homepage: https://github.com/Parallel-in-Time/qmat
Documentation: https://qmat.readthedocs.io/
License: BSD 2-Clause License Copyright (c) 2024, Parallel-in-Time (PinT) Algorithms Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Latest release: 0.1.19
published 6 months ago

Versions: 28
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 7,784 Last month

Rankings

Dependent packages count: 10.8%

Average: 35.8%

Dependent repos count: 60.8%

Maintainers (1)

tlunet