Bempp-cl

Bempp-cl: A fast Python based just-in-time compiling boundary element library. - Published in JOSS (2021)

https://github.com/bempp/bempp-cl

Science Score: 98.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 4 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 4 months ago · JSON representation ·

Repository

A fast Python based just-in-time compiling boundary element library

Basic Info
  • Host: GitHub
  • Owner: bempp
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage: http://www.bempp.com
  • Size: 80.6 MB
Statistics
  • Stars: 179
  • Watchers: 14
  • Forks: 45
  • Open Issues: 31
  • Releases: 13
Created over 6 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Codemeta

README.md

Bempp-cl

Documentation Status DOI

Bempp-cl is an open-source boundary element method library that can be used to assemble all the standard integral kernels for Laplace, Helmholtz, modified Helmholtz, and Maxwell problems. The library has a user-friendly Python interface that allows the user to use BEM to solve a variety of problems, including problems in electrostatics, acoustics and electromagnetics.

Bempp-cl began life as BEM++, and was a Python library with a C++ computational core. The ++ slowly changed into pp as functionality gradually moved from C++ to Python with only a few core routines remaining in C++. Bempp-cl is the culmination of efforts to fully move to Python. It is an almost complete rewrite of Bempp: the C++ core has been replaced by highly SIMD optimised just-in-time compiled OpenCL kernels, or alternatively, by just-in-time compiled Numba routines, which are automatically used on systems that do not provide OpenCL drivers. User visible functionality is strictly separated from the implementation of computational routines, making it easy to add other discretisation technologies in the future (e.g. future support for SYCL-based heterogeneous compute devices).

Installation

Bempp-cl can be installed from this repository by running: bash python -m pip install .

Full installation instuctions, including installation of dependencies, can be found at bempp.com/installation.html.

Documentation

Full documentation of Bempp can be found at bempp.com/documentation and in the Bempp Handbook. Automatically generated documentation of the Python API can be found on Read the Docs.

Testing

The functionality of the library can be tested by running: bash python -m pytest test/unit Larger validation tests that compare the output with the previous version of Bempp can be run with: bash python -m pytest test/validation

Getting help

Errors in the library should be added to the GitHub issue tracker.

Questions about the library and its use can be asked on the Bempp Discourse.

Licence

Bempp-cl is licensed under an MIT licence. Full text of the licence can be found here.

Owner

  • Name: Bempp
  • Login: bempp
  • Kind: organization

JOSS Publication

Bempp-cl: A fast Python based just-in-time compiling boundary element library.
Published
March 19, 2021
Volume 6, Issue 59, Page 2879
Authors
Timo Betcke ORCID
Department of Mathematics, University College London
Matthew W. Scroggs ORCID
Department of Engineering, University of Cambridge
Editor
Marie E. Rognes ORCID
Tags
OpenCL boundary element method partial differential equations numerical analysis

Citation (CITATION.md)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Betcke"
  given-names: "Timo"
  orcid: "https://orcid.org/0000-0002-3323-2110"
- family-names: "Scroggs"
  given-names: "Matthew W."
  orcid: "https://orcid.org/0000-0002-4658-2443"
title: "Bempp-cl"
version: 0.2.4
date-released: 2021-03-18
url: "https://github.com/bempp/bempp-cl"
preferred-citation:
  type: article
  authors:
  - family-names: "Betcke"
    given-names: "Timo"
    orcid: "https://orcid.org/0000-0002-3323-2110"
  - family-names: "Scroggs"
    given-names: "Matthew W."
    orcid: "https://orcid.org/0000-0002-4658-2443"
  doi: "10.21105/joss.02879"
  journal: "Journal of Open Source Software"
  title: "Bempp-cl: A fast Python based just-in-time compiling boundary element library"
  volume: 6
  issue: 59
  start: 2879
  month: 3
  year: 2021

CodeMeta (codemeta.json)

{
  "@context": "https://raw.githubusercontent.com/codemeta/codemeta/master/codemeta.jsonld",
  "@type": "Code",
  "author": [
    {
      "@id": "0000-0002-3323-2110",
      "@type": "Person",
      "email": "t.betcke@ucl.ac.uk",
      "name": "Timo Betcke",
      "affiliation": "Department of Mathematics, University College London"
    },
    {
      "@id": "0000-0002-4658-2443",
      "@type": "Person",
      "email": "mws48@cam.ac.uk",
      "name": "Matthew Scroggs",
      "affiliation": "Department of Engineering, University of Cambridge"
    }
  ],
  "identifier": "",
  "codeRepository": "https://github.com/bempp/bempp-cl",
  "datePublished": "2020-09-14",
  "dateModified": "2021-03-18",
  "dateCreated": "2020-09-14",
  "description": "A fast Python based just-in-time compiling boundary element library",
  "keywords": "Python, OpenCL, boundary element method, partial differential equations, integral equations, numerical analysis",
  "license": "MIT",
  "title": "Bempp-cl",
  "version": "v0.4.2"
}

GitHub Events

Total
  • Create event: 6
  • Release event: 3
  • Issues event: 12
  • Watch event: 33
  • Delete event: 2
  • Issue comment event: 14
  • Push event: 88
  • Pull request event: 7
  • Fork event: 10
Last Year
  • Create event: 6
  • Release event: 3
  • Issues event: 12
  • Watch event: 33
  • Delete event: 2
  • Issue comment event: 14
  • Push event: 88
  • Pull request event: 7
  • Fork event: 10

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 832
  • Total Committers: 13
  • Avg Commits per committer: 64.0
  • Development Distribution Score (DDS): 0.382
Past Year
  • Commits: 59
  • Committers: 6
  • Avg Commits per committer: 9.833
  • Development Distribution Score (DDS): 0.085
Top Committers
Name Email Commits
Matthew Scroggs m****s@g****m 514
Timo Betcke t****e@g****m 277
evantwout 7****t 11
Timo Betcke b****e@r****n 10
paul p****l@u****l 9
bemppbot 7****t 3
Timo Betcke b****e@l****n 2
boomboompsh b****h 1
SDSearch 5****h 1
Mario Echeverri Bautista 6****n 1
Ignacia Fierro-Piccardo i****o@g****m 1
Ian MacDougall Murray 7****y 1
Zhi Li l****4@o****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 69
  • Total pull requests: 66
  • Average time to close issues: 4 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 35
  • Total pull request authors: 9
  • Average comments per issue: 1.49
  • Average comments per pull request: 0.18
  • Merged pull requests: 59
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 13
  • Pull requests: 9
  • Average time to close issues: 25 days
  • Average time to close pull requests: about 1 month
  • Issue authors: 11
  • Pull request authors: 3
  • Average comments per issue: 0.85
  • Average comments per pull request: 0.0
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • mscroggs (22)
  • tbetcke (6)
  • jahargreaves (3)
  • pescap (3)
  • fltodd (2)
  • xiamengqi2012 (2)
  • lz069 (2)
  • Ssssz (2)
  • Sentient07 (1)
  • Railon69 (1)
  • ymei (1)
  • Insoka (1)
  • joverbee (1)
  • lzyw1214 (1)
  • antoineRallu (1)
Pull Request Authors
  • mscroggs (54)
  • evantwout (12)
  • deweatherman (4)
  • pescap (4)
  • ignacia-fp (2)
  • i-murray (2)
  • tbetcke (1)
  • lz069 (1)
  • SDSearch (1)
Top Labels
Issue Labels
enhancement (13) bug (8) installation (2)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 435 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 15
  • Total maintainers: 2
pypi.org: bempp-cl

The Bempp boundary element library

  • Documentation: https://bempp-cl.readthedocs.io/
  • License: Copyright 2019-2020 The Bempp Team (www.bempp.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.4.2
    published 9 months ago
  • Versions: 9
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 435 Last month
Rankings
Stargazers count: 6.6%
Forks count: 7.0%
Dependent packages count: 10.0%
Average: 11.9%
Downloads: 14.3%
Dependent repos count: 21.8%
Maintainers (2)
Last synced: 4 months ago
conda-forge.org: bempp-cl

Bempp-cl is a an OpenCL based boundary element library for Python.

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Forks count: 30.3%
Stargazers count: 31.2%
Dependent repos count: 34.0%
Average: 36.7%
Dependent packages count: 51.2%
Last synced: 4 months ago

Dependencies

.github/workflows/notebook-images.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/setup-buildx-action v1 composite
.github/workflows/release.yml actions
  • actions/checkout main composite
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/setup-buildx-action v1 composite
  • pypa/gh-action-pypi-publish master composite
.github/workflows/run-tests.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/setup-buildx-action v1 composite
Dockerfile docker
  • bempp-dev-env-with-dolfin latest build
  • bempp-dev-env-with-dolfinx latest build
  • bempp-dev-env-with-dolfinx-numba latest build
  • dolfinx/dev-env stable build
  • ubuntu 20.04 build
docs/requirements.txt pypi
  • sphinx-autoapi *
.github/workflows/weekly-tests.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
  • docker/setup-buildx-action v1 composite
setup.py pypi