pyparareal

A basic implementation of the Parareal algorithm in Python.

https://github.com/kpentland/pyparareal

Science Score: 44.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
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.0%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

A basic implementation of the Parareal algorithm in Python.

Basic Info
  • Host: GitHub
  • Owner: kpentland
  • Language: Python
  • Default Branch: main
  • Size: 38.1 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed over 2 years ago
Metadata Files
Readme Citation

README.md

pyParareal

This repository contains a basic implementation of the Parareal algorithm - wrtitten in Python.

Contained within are two test problems that Parareal will solve using user-specified coarse and fine solvers (here they are implemented as explicit Runge-Kutta methods). This version of Parareal has the option to run in parallel (using the 'multiprocessing' package) but is written mostly for educational purposes and to provide an idea of how it works.

Please feel free to use and adapt the code as you wish but please cite this GitHub page (see side panel) if used in published works. Please also get in contact if there are any issues with running the code.

We make use of the following Python packages: numpy, multiprocessing, time, os, matplotlib.

Files

  • Parareal.py: script that contains the 'Parareal', 'RungeKutta', 'CoarseSolver', and 'FineSolver' functions used in the test scripts below.

  • FHNTestSerial.py: test script that solves the FitzHugh-Nagumo model using Parareal (serially).

  • Lorenz63TestSerial.py: test script that solves the Lorenz63 using Parareal (serially).

  • FHNTestParallel.py: test script that solves the FitzHugh-Nagumo model using Parareal (in parallel - must run from terminal).

  • Lorenz63TestParallel.py: test script that solves the Lorenz63 using Parareal (in parallel - must run from terminal).

  • probnum.mplstyle: a style-file for plotting (adapted from the original - which is from ProbNum ).

Authors

  • Kamran Pentland - Culham Centre for Fusion Energy, UKAEA

Owner

  • Name: Kamran Pentland
  • Login: kpentland
  • Kind: user

PhD student in the Mathematics of Systems CDT at the University of Warwick

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use/modify this code, please cite it as below.
authors:
  - family-names: Pentland
    given-names: Kamran
    orcid: "https://orcid.org/0000-0001-9530-1890"
title: "pyParareal"
date-released: 2023

GitHub Events

Total
Last Year