PointNeighbors

PointNeighbors.jl: Neighborhood search with fixed search radius in Julia

https://github.com/trixi-framework/pointneighbors.jl

Science Score: 49.0%

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

  • 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
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary

Keywords

julia neighborhood-search particles simulation smoothed-particle-hydrodynamics

Keywords from Contributors

multiphysics hacking mesh interpretability standardization optim parallel interactive pinn robust
Last synced: 6 months ago · JSON representation

Repository

PointNeighbors.jl: Neighborhood search with fixed search radius in Julia

Basic Info
Statistics
  • Stars: 27
  • Watchers: 5
  • Forks: 8
  • Open Issues: 25
  • Releases: 24
Topics
julia neighborhood-search particles simulation smoothed-particle-hydrodynamics
Created almost 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Security Authors Zenodo

README.md

PointNeighbors.jl

Docs-stable Docs-dev Slack Youtube Build Status Codecov SciML Code Style License: MIT DOI

PointNeighbors.jl is a package for neighborhood search with fixed search radius in 1D, 2D and 3D point clouds.

Features

  • Several implementations of neighborhood search with fixed search radius
  • Focus on fast incremental updates to be usable for particle-based simulations with frequent updates
  • Designed as a "playground" to easily switch between different implementations and data structures
  • Common API over all implementations
  • Extensive benchmark suite to study different implementations (work in progress)
  • GPU compatibility (work in progress)

| Implementation | Description | Features | Query | Update | GPU-compatible | | ------------- | ------------- | --- | :--: | :--: | :--: | | GridNeighborhoodSearch with DictionaryCellList | Grid-based NHS with Julia Dict backend | Infinite domain | Fast | Fast | ❌ | | GridNeighborhoodSearch with FullGridCellList | Grid-based NHS allocating all cells of the domain | Finite domain, but efficient memory layout for densely filled domain. | Faster | Fastest | ✅ | | PrecomputedNeighborhoodSearch | Precompute neighbor lists | Best for TLSPH without NHS updates. Not suitable for updates in every time step. | Fastest | Very slow | ❌ |

Benchmarks

The following benchmarks were conducted on an AMD Ryzen Threadripper 3990X using 128 threads.

Benchmark of a single force computation step of a Weakly Compressible SPH (WCSPH) simulation: wcsph

Benchmark of an incremental update similar to a WCSPH simulation (note the log scale): update

Benchmark of a full right-hand side evaluation of a WCSPH simulation (note the log scale): rhs

Packages using PointNeighbors.jl

If you're using PointNeighbors.jl in your package, please feel free to open a PR adding it to this list.

Cite Us

If you use PointNeighbors.jl in your own research or write a paper using results obtained with the help of PointNeighbors.jl, please cite it as bibtex @misc{pointneighbors, title={{P}oint{N}eighbors.jl: {N}eighborhood search with fixed search radius in {J}ulia}, author={Erik Faulhaber and Niklas Neher and Sven Berger and Michael Schlottke-Lakemper and Gregor Gassner}, year={2024}, howpublished={\url{https://github.com/trixi-framework/PointNeighbors.jl}}, doi={10.5281/zenodo.12702157} }

Owner

  • Name: Trixi.jl
  • Login: trixi-framework
  • Kind: organization

Adaptive high-order numerical simulations of hyperbolic PDEs in Julia

GitHub Events

Total
  • Create event: 54
  • Commit comment event: 25
  • Release event: 6
  • Issues event: 12
  • Watch event: 6
  • Delete event: 37
  • Issue comment event: 106
  • Push event: 327
  • Pull request review comment event: 79
  • Pull request review event: 128
  • Pull request event: 97
  • Fork event: 3
Last Year
  • Create event: 54
  • Commit comment event: 25
  • Release event: 6
  • Issues event: 12
  • Watch event: 6
  • Delete event: 37
  • Issue comment event: 106
  • Push event: 327
  • Pull request review comment event: 79
  • Pull request review event: 128
  • Pull request event: 97
  • Fork event: 3

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 122
  • Total Committers: 10
  • Avg Commits per committer: 12.2
  • Development Distribution Score (DDS): 0.221
Past Year
  • Commits: 62
  • Committers: 9
  • Avg Commits per committer: 6.889
  • Development Distribution Score (DDS): 0.339
Top Committers
Name Email Commits
Erik Faulhaber 4****r 95
dependabot[bot] 4****] 14
github-actions[bot] 4****] 5
Sven Berger b****n@g****m 2
RubberLanding n****n@t****m 1
Niklas Neher 7****s 1
Michael Schlottke-Lakemper m****l@s****m 1
Kai Partmann 6****n 1
Joshua Lampert 5****t 1
Jan-Timo Hesse 8****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 24
  • Total pull requests: 193
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 10 days
  • Total issue authors: 8
  • Total pull request authors: 11
  • Average comments per issue: 1.21
  • Average comments per pull request: 1.22
  • Merged pull requests: 147
  • Bot issues: 1
  • Bot pull requests: 39
Past Year
  • Issues: 10
  • Pull requests: 95
  • Average time to close issues: 23 days
  • Average time to close pull requests: 8 days
  • Issue authors: 6
  • Pull request authors: 8
  • Average comments per issue: 2.0
  • Average comments per pull request: 1.15
  • Merged pull requests: 66
  • Bot issues: 1
  • Bot pull requests: 26
Top Authors
Issue Authors
  • efaulhaber (15)
  • marklau34 (2)
  • LasNikas (2)
  • rveltz (1)
  • KristofferC (1)
  • github-actions[bot] (1)
  • JuliaTagBot (1)
  • Leibniz1697 (1)
Pull Request Authors
  • efaulhaber (127)
  • dependabot[bot] (30)
  • github-actions[bot] (9)
  • RubberLanding (6)
  • LasNikas (5)
  • svchb (5)
  • sloede (4)
  • vchuravy (2)
  • kaipartmann (2)
  • JTHesse (2)
  • JoshuaLampert (1)
Top Labels
Issue Labels
enhancement (4) bug (2) gpu (2) performance (1)
Pull Request Labels
dependencies (31) enhancement (25) gpu (21) bug (16) breaking changes (14) performance (13) github_actions (11) documentation (10) testing (4)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 23 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 24
juliahub.com: PointNeighbors

PointNeighbors.jl: Neighborhood search with fixed search radius in Julia

  • Versions: 24
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 23 Total
Rankings
Dependent repos count: 9.5%
Average: 23.9%
Dependent packages count: 38.3%
Last synced: 6 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia v2 composite
.github/workflows/Documenter.yml actions
  • actions/checkout v4 composite
  • julia-actions/cache v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/FormatCheck.yml actions
  • actions/checkout v4 composite
  • julia-actions/cache v1 composite
  • julia-actions/setup-julia v2 composite
.github/workflows/SpellCheck.yml actions
  • actions/checkout v4 composite
  • crate-ci/typos v1.21.0 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4 composite
  • julia-actions/cache v1 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/julia-processcoverage v1 composite
  • julia-actions/julia-runtest v1 composite
  • julia-actions/setup-julia v2 composite