Data

Tools

Indexes

Applications

Experiments

Open Source Science

pgdrome

A FEniCS based python module of the Proper Generalized Decomposition (PGD) method.

https://github.com/bamresearch/pgdrome

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 3 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 (12.8%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A FEniCS based python module of the Proper Generalized Decomposition (PGD) method.

Basic Info
  • Host: GitHub
  • Owner: BAMresearch
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 370 KB
Statistics
  • Stars: 10
  • Watchers: 3
  • Forks: 5
  • Open Issues: 2
  • Releases: 8
Created about 4 years ago · Last pushed about 1 year ago
Metadata Files
Readme License Citation

README.md

PGDrome

Tests for pgdrome Publish conda package DOI

A FEniCS based python module of the Proper Generalized Decomposition (PGD) method.

Description

  • The progressive PGD solver is implemented following publication such as

"Recent advances and new challenges in the use of the proper generalized decomposition for solving multidimensional models." Chinesta, F., Ammar, A. and Cueto, E. Archive of Computational Methods in Engineering 17/4 (2010): 327-350.

"A Proper Generalized Decomposition for the solution of elliptic problems in abstract form by using a functional Eckart–Young approach" Falco, A. and Nouy, A. Journal of Mathematical Analysis and Applications 376/2 (2011): 469-480.

"A nonintrusive proper generalized decomposition scheme with application in biomechanics" Zou, X., Conti, M., Díez,P. and Auricchio, F. International Journal of Numerical Methods in Engineering 113/2 (2017): 230-251.

"On the Existence of a Progressive Variational Vademecum based on the Proper Generalized Decomposition for a Class of Elliptic Parameterized Problems" Falcó A., Montés, N., Chinesta, F., Hilario, L. and Mora, M.C. Journal of Computational and Applied Mathematics 330 (2018): 1093-1107.

PGDrome in other projects

Requirements

  • Python >= v3.8
  • A working installation of FEniCS v2019.1.0 (including DOLFIN python interface)
    • Set up e.g. via conda install -c conda-forge fenics=2019.1.0 ### Install module
  • Direct from conda via conda install -c bam77 pgdrome
  • Using setup.py git clone https://github.com/BAMresearch/PGDrome.git cd PGDrome python3 -m pip install -e . -e flag creates a symlink instead of copying it. So modifying does not require another installation.

uninstall with python3 -m pip uninstall PGDrome

Conda environment for development (including dolfin)

Requirements

  • Python >= v3.8
  • A working installation of FEniCS v2019.1.0 (including DOLFIN python interface)
  • Black code style
  • ...
  • Set up e.g. via conda s. below ### Installation
  • create conda environment with requirements from file
    • globally in user miniconda folder cd PGDrome conda env create -f environment.yml conda activate pgdrome
    • within main project folder cd PGDrome conda env create --prefix ./conda-env -f environment.yml (conda env update --prefix ./conda-env -f environment.yml --prune) conda activate ./conda-env

Tests for development

Test with pytest or standalone pytest tests

Note

  • fenicstools (required for special sensor evaluations install only if required!!!) git clone https://github.com/mikaem/fenicstools.git cd fenicstools python3 setup.py install python3 -m pip install cppimport

Owner

  • Name: Bundesanstalt für Materialforschung und -prüfung
  • Login: BAMresearch
  • Kind: organization
  • Email: oss@bam.de
  • Location: Berlin/Germany

German Federal scientific research institute for materials testing and research

Citation (CITATION.cff) 

cff-version: 1.2.0
title: PGDrome
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Annika
    family-names: Robens-Radermacher
    email: annika.robens-radermacher@bam.de
    affiliation: Bundesanstalt für Materialforschung und -prüfung (BAM)
    orcid: 'https://orcid.org/0000-0001-9653-6085'
  - given-names: Dominic
    family-names: Strobl
    email: dominic.strobl@bam.de
    affiliation: Bundesanstalt für Materialforschung und -prüfung (BAM)
    orcid: 'https://orcid.org/0000-0001-8873-7792'
repository-code: 'https://github.com/BAMresearch/PGDrome'
abstract: >-
  A FEniCS based python module of the Proper Generalized
  Decomposition (PGD) method.
keywords:
  - reduced order modelling
  - proper generalized decomposition
license: MIT

GitHub Events

Total
  • Watch event: 4
  • Push event: 1
  • Fork event: 1
  • Create event: 1
Last Year
  • Watch event: 4
  • Push event: 1
  • Fork event: 1
  • Create event: 1

Dependencies

setup.py pypi
  • h5py *
  • lxml *
  • numpy *
  • scipy *
.github/workflows/tests.yml actions
  • actions/checkout v2 composite
  • conda-incubator/setup-miniconda v2 composite
pyproject.toml pypi
  • h5py >=2.10
  • lxml >=4.5
  • numpy >=1.18
  • scipy >=1.4
.github/workflows/publish_conda.yml actions
  • actions/checkout v3 composite
  • conda-incubator/setup-miniconda v2 composite
environment.yml conda
  • black
  • fenics 2019.1.0.*
  • h5py
  • hdf5
  • numpy
  • pip
  • pytest
  • python >=3.8,<3.10
  • scipy