Basix

Basix: a runtime finite element basis evaluation library - Published in JOSS (2022)

https://github.com/fenics/basix

Science Score: 100.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 JOSS metadata
  • Academic publication links
  • Committers with academic emails
    4 of 27 committers (14.8%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

basis-functions fenicsx finite-elements high-order

Keywords from Contributors

mesh blackhole numerical-methods
Last synced: 4 months ago · JSON representation ·

Repository

FEniCSx finite element basis evaluation library

Basic Info
  • Host: GitHub
  • Owner: FEniCS
  • License: mit
  • Language: C++
  • Default Branch: main
  • Homepage: https://fenicsproject.org
  • Size: 3.88 MB
Statistics
  • Stars: 114
  • Watchers: 17
  • Forks: 42
  • Open Issues: 50
  • Releases: 10
Topics
basis-functions fenicsx finite-elements high-order
Created about 5 years ago · Last pushed 4 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation

README.md

Basix

Basix CI Spack install DefElement verification

Basix is a finite element definition and tabulation runtime library. Basix allows users to:

  • evaluate finite element basis functions and their derivatives at a set of points;
  • access geometric and topological information about reference cells;
  • apply push forward and pull back operations to map data between a reference cell and a physical cell;
  • permute and transform DOFs to allow higher-order elements to be use on arbitrary meshes; and
  • interpolate into and between finite element spaces.

Basix includes a range of built-in elements, and also allows the user to define their own custom elements.

Basix is one of the components of FEniCSx, alongside UFL, FFCx, and DOLFINx.

Installation

To install Basix: console pip install fenics-basix We currently build binary wheels for Python 3.8 to 3.12 for Linux (x86-64, aarch64), macOS (x86-64, arm64) and Windows (x86-64).

For advanced and developer installation instructions see the more detailed install instructions

Documentation

Documentation of Basix can be found at https://docs.fenicsproject.org/basix/main/.

Support

If you find a bug in Basix, you can report it on the GitHub issue tracker.

Questions about using Basix can be asked on the FEniCS discourse group.

Contributing

Information about how to contribute to Basix can be found here.

Supported elements

Interval

In Basix, the sub-entities of the reference interval are numbered as follows:

The numbering of a reference interval

The following elements are supported on an interval:

Triangle

In Basix, the sub-entities of the reference triangle are numbered as follows:

The numbering of a reference triangle

The following elements are supported on a triangle:

Quadrilateral

In Basix, the sub-entities of the reference quadrilateral are numbered as follows:

The numbering of a reference quadrilateral

The following elements are supported on a quadrilateral:

Tetrahedron

In Basix, the sub-entities of the reference tetrahedron are numbered as follows:

The numbering of a reference tetrahedron

The following elements are supported on a tetrahedron:

Hexahedron

In Basix, the sub-entities of the reference hexahedron are numbered as follows:

The numbering of a reference hexahedron

The following elements are supported on a hexahedron:

Prism

In Basix, the sub-entities of the reference prism are numbered as follows:

The numbering of a reference prism

The following elements are supported on a prism:

Pyramid

In Basix, the sub-entities of the reference pyramid are numbered as follows:

The numbering of a reference pyramid

The following elements are supported on a pyramid:

Owner

  • Name: FEniCS Project
  • Login: FEniCS
  • Kind: organization

JOSS Publication

Basix: a runtime finite element basis evaluation library
Published
May 25, 2022
Volume 7, Issue 73, Page 3982
Authors
Matthew W. Scroggs ORCID
Department of Engineering, University of Cambridge
Igor A. Baratta ORCID
Department of Engineering, University of Cambridge
Chris N. Richardson ORCID
BP Institute, University of Cambridge
Garth N. Wells ORCID
Department of Engineering, University of Cambridge
Editor
Jed Brown ORCID
Tags
finite element method basis functions numerical analysis

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it as below.
license: MIT
url: https://github.com/FEniCS/basix
preferred-citation:
  type: article
  authors:
  - family-names: Scroggs
    given-names: Matthew W.
    orcid: 0000-0002-4658-2443
  - family-names: Baratta
    given-names: Igor A.
    orcid: 0000-0003-4298-2973
  - family-names: Richardson
    given-names: Chris N.
    orcid: 0000-0003-3137-1392
  - family-names: Wells
    given-names: Garth N.
    orcid: 0000-0001-5291-7951
  doi: 10.21105/joss.03982
  journal: Journal of Open Source Software
  title: "Basix: a runtime finite element basis evaluation library"
  volume: 7
  issue: 73
  start: 3982
  month: 5
  year: 2022

GitHub Events

Total
  • Issues event: 28
  • Watch event: 24
  • Delete event: 76
  • Issue comment event: 27
  • Push event: 224
  • Pull request review comment event: 15
  • Pull request review event: 25
  • Pull request event: 92
  • Fork event: 9
  • Create event: 82
Last Year
  • Issues event: 28
  • Watch event: 24
  • Delete event: 78
  • Issue comment event: 28
  • Push event: 224
  • Pull request review comment event: 15
  • Pull request review event: 25
  • Pull request event: 93
  • Fork event: 9
  • Create event: 82

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 1,033
  • Total Committers: 27
  • Avg Commits per committer: 38.259
  • Development Distribution Score (DDS): 0.613
Past Year
  • Commits: 58
  • Committers: 11
  • Avg Commits per committer: 5.273
  • Development Distribution Score (DDS): 0.741
Top Committers
Name Email Commits
Matthew Scroggs m****s@g****m 400
Chris Richardson c****s@b****k 274
Garth N. Wells g****0@c****k 212
Jack S. Hale m****l@j****k 74
Igor Baratta i****a@g****m 18
Jørgen Schartum Dokken d****n@s****o 12
Paul T. Kühner 5****e 10
Francesco Ballarin f****n@u****t 7
Michal Habera m****a@g****m 4
Adeeb Arif Kor m****4@c****k 3
dependabot[bot] 4****] 3
Abdullah Mujahid a****5@g****m 1
Andreas Zilian a****n@u****u 1
Connor Pierce c****8@g****m 1
Drew Parsons d****s@e****m 1
Johnny Vogels 3****9 1
Lawrence Mitchell l****e@w****k 1
Massimiliano Leoni l****1@g****m 1
Mehdi Slimani 5****m 1
Min RK b****k@g****m 1
Renato Caldas r****o@c****m 1
Russo Samuel r****0@g****m 1
Simon Praetorius s****p@g****e 1
Thomas Titscher t****r@g****m 1
luzpaz l****z 1
nikhilTkur n****4@i****n 1
tiagovla 3****a 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 85
  • Total pull requests: 431
  • Average time to close issues: 4 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 26
  • Total pull request authors: 23
  • Average comments per issue: 0.84
  • Average comments per pull request: 0.54
  • Merged pull requests: 350
  • Bot issues: 0
  • Bot pull requests: 16
Past Year
  • Issues: 26
  • Pull requests: 142
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 7 days
  • Issue authors: 9
  • Pull request authors: 12
  • Average comments per issue: 0.12
  • Average comments per pull request: 0.42
  • Merged pull requests: 99
  • Bot issues: 0
  • Bot pull requests: 16
Top Authors
Issue Authors
  • mscroggs (37)
  • garth-wells (9)
  • jorgensd (8)
  • jhale (5)
  • drew-parsons (3)
  • chrisrichardson (2)
  • yurivict (2)
  • massimiliano-leoni (1)
  • yalavarthivk (1)
  • bagla0 (1)
  • dyanoo (1)
  • TTitscher (1)
  • Chenyxld (1)
  • jpdean (1)
  • schnellerhase (1)
Pull Request Authors
  • mscroggs (145)
  • garth-wells (105)
  • jhale (67)
  • schnellerhase (29)
  • dependabot[bot] (16)
  • jorgensd (13)
  • chrisrichardson (11)
  • francesco-ballarin (10)
  • jmv2009 (7)
  • ampdes (4)
  • minrk (4)
  • michalhabera (4)
  • ordinary-slim (2)
  • samuel0007 (2)
  • IgorBaratta (2)
Top Labels
Issue Labels
enhancement (22) bug (12) housekeeping (6) proposal (4) CI (3) packaging (3) installation (3) task (3) good first issue (3) documentation (3) high priority (2) testing (2) question (1) help wanted (1) new-element (1)
Pull Request Labels
bug (23) housekeeping (19) CI (17) enhancement (16) dependencies (16) documentation (11) github_actions (11) backport? (6) python (5) installation (5) nanobind (4) performance (3) packaging (3) type-hints (2) proposal (1) task (1) testing (1) high priority (1)

Packages

  • Total packages: 5
  • Total downloads:
    • pypi 1,515 last-month
  • Total docker downloads: 92,536
  • Total dependent packages: 10
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 23
  • Total maintainers: 5
pypi.org: fenics-basix

Basix Python interface

  • Homepage: https://fenicsproject.org
  • Documentation: https://docs.fenicsproject.org
  • License: MIT License Copyright (c) 2020 FEniCS Project 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.9.0
    published about 1 year ago
  • Versions: 7
  • Dependent Packages: 2
  • Dependent Repositories: 1
  • Downloads: 1,515 Last month
  • Docker Downloads: 92,536
Rankings
Docker downloads count: 1.3%
Dependent packages count: 3.1%
Average: 9.6%
Downloads: 12.1%
Dependent repos count: 21.7%
Maintainers (1)
Last synced: 4 months ago
spack.io: fenics-basix

Basix is a finite element definition and tabulation runtime library

  • Versions: 4
  • Dependent Packages: 3
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Dependent packages count: 14.2%
Average: 14.5%
Forks count: 21.3%
Stargazers count: 22.6%
Last synced: 4 months ago
spack.io: py-fenics-basix

Python interface to Basix, a finite element definition and tabulation runtime library

  • Versions: 4
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Dependent repos count: 0.0%
Average: 18.0%
Forks count: 21.3%
Stargazers count: 22.6%
Dependent packages count: 28.1%
Last synced: 4 months ago
conda-forge.org: fenics-libbasix
  • Versions: 4
  • Dependent Packages: 2
  • Dependent Repositories: 0
Rankings
Dependent packages count: 19.5%
Average: 32.4%
Dependent repos count: 34.0%
Forks count: 35.4%
Stargazers count: 40.5%
Last synced: 4 months ago
conda-forge.org: fenics-basix
  • Versions: 4
  • Dependent Packages: 2
  • Dependent Repositories: 0
Rankings
Dependent packages count: 19.5%
Average: 32.4%
Dependent repos count: 34.0%
Forks count: 35.4%
Stargazers count: 40.5%
Last synced: 4 months ago

Dependencies

.github/workflows/build-wheels.yml actions
  • actions/checkout v3 composite
  • actions/download-artifact v3 composite
  • actions/upload-artifact v3 composite
  • docker/setup-qemu-action v2 composite
  • pypa/cibuildwheel v2.11.1 composite
  • pypa/gh-action-pypi-publish v1.5.1 composite
.github/workflows/dolfin-tests.yml actions
  • actions/checkout v3 composite
.github/workflows/ffcx-tests.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/intel.yml actions
  • actions/checkout v3 composite
.github/workflows/mac.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/pythonapp.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/setup-python v3 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v3 composite
.github/workflows/redhat.yml actions
  • actions/checkout v3 composite
.github/workflows/sonarcloud.yml actions
  • actions/cache v1 composite
  • actions/checkout v3 composite
  • actions/setup-java v1 composite
python/setup.py pypi
  • numpy >=1.21
pyproject.toml pypi
  • numpy >=1.21
python/pyproject.toml pypi