Smesh

Smesh.jl is a lightweight wrapper of the Fortran package smesh for generation and handling of unstructured meshes

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

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 5 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 (16.0%) to scientific vocabulary

Keywords from Contributors

mesh parallel parallel-computing multiphysics smoothed-particle-hydrodynamics geometry high-order-methods fem finite-elements sequences
Last synced: 9 months ago · JSON representation ·

Repository

Smesh.jl is a lightweight wrapper of the Fortran package smesh for generation and handling of unstructured meshes

Basic Info
Statistics
  • Stars: 3
  • Watchers: 9
  • Forks: 1
  • Open Issues: 2
  • Releases: 4
Created over 2 years ago · Last pushed 9 months ago
Metadata Files
Readme License Citation Security Zenodo

README.md

Smesh.jl

Docs-stable Docs-dev Build Status Coveralls Codecov License: MIT DOI

Smesh.jl is a Julia wrapper packagae for smesh, a simple Fortran package for generating and handling unstructured triangular and polygonal meshes.

Getting started

Prerequisites

If you have not yet installed Julia, please follow the instructions for your operating system. Smesh.jl works with Julia v1.8 and later on Linux, macOS and Windows platforms.

Note: On pre-Apple Silicon systems with macOS, Julia v1.10 or later is required.

Installation

Since Smesh.jl is a registered Julia package, you can install it by executing the following command in the Julia REPL: julia julia> import Pkg; Pkg.add("Smesh")

By default, Smesh.jl uses pre-compiled binaries of the smesh package that will get automatically installed when obtaining Smesh.jl. However, you can also make use of a local smesh build. For this, create a LocalPreferences.toml file next to your Project.toml for the project in which you use Smesh.jl. It should have the following content:

  • On Linux: toml [Smesh] libsmesh = "<smesh-install-prefix>/lib/libsmesh.so"
  • On macOS: toml [Smesh] libsmesh = "<smesh-install-prefix>/lib/libsmesh.dylib"
  • On Windows: toml [Smesh] libsmesh = "<smesh-install-prefix>/bin/libsmesh.dll"

Where <smesh-install-prefix> is where you have installed the local smesh build.

Usage

The easiest way to get started is to run one of the examples from the examples directory by includeing them in Julia, e.g., ``` julia> using Smesh

julia> include(joinpath(pkgdir(Smesh), "examples", "builddelaunaytriangulation.jl")) Computing Delaunay triangulation. Triangulation elements: 2 Total flipped edges: 0 Average search time: 1.25 Flips/triangle: 0.00 Flips/node: 0.00 3×2 Matrix{Int64}: 3 1 1 3 2 4 ```

Referencing

If you use Smesh.jl in your own research, please cite this repository as follows: bibtex @misc{chiocchetti2024smesh_jl, title={Smesh.jl: {A} {J}ulia wrapper for the Fortran package smesh to generate and handle unstructured meshes}, author={Chiocchetti, Simone and Bolm, Benjamin and Schlottke-Lakemper, Michael}, year={2024}, howpublished={\url{https://github.com/trixi-framework/Smesh.jl}}, doi={10.5281/zenodo.10581816} } Please also consider citing the upstream package smesh (doi:10.5281/zenodo.10579422) itself.

Authors

Smesh.jl was initiated by Simone Chiocchetti (University of Cologne, Germany), Benjamin Bolm (University of Cologne, Germany), and Michael Schlottke-Lakemper (RWTH Aachen University/High-Performance Computing Center Stuttgart (HLRS), Germany) who are also its principal maintainers.

License and contributing

Smesh.jl and smesh itself are available under the MIT license (see LICENSE.md). Contributions by the community are very welcome!

Owner

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

Adaptive high-order numerical simulations of hyperbolic PDEs in Julia

Citation (CITATION.bib)

@misc{chiocchetti2024smesh_jl,
  title={Smesh.jl: {A} {J}ulia wrapper for the Fortran package smesh to generate and handle unstructured meshes},
  author={Chiocchetti, Simone and Bolm, Benjamin and Schlottke-Lakemper, Michael},
  year={2024},
  howpublished={\url{https://github.com/trixi-framework/Smesh.jl}},
  doi={10.5281/zenodo.10581816}
}

GitHub Events

Total
  • Delete event: 11
  • Issue comment event: 3
  • Push event: 18
  • Pull request event: 23
  • Create event: 11
Last Year
  • Delete event: 11
  • Issue comment event: 3
  • Push event: 18
  • Pull request event: 23
  • Create event: 11

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 43
  • Total Committers: 4
  • Avg Commits per committer: 10.75
  • Development Distribution Score (DDS): 0.674
Past Year
  • Commits: 43
  • Committers: 4
  • Avg Commits per committer: 10.75
  • Development Distribution Score (DDS): 0.674
Top Committers
Name Email Commits
Benjamin Bolm 7****m 14
dependabot[bot] 4****] 14
Michael Schlottke-Lakemper m****l@s****m 14
Hendrik Ranocha r****a 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 3
  • Total pull requests: 71
  • Average time to close issues: about 10 hours
  • Average time to close pull requests: 12 days
  • Total issue authors: 3
  • Total pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.7
  • Merged pull requests: 61
  • Bot issues: 0
  • Bot pull requests: 45
Past Year
  • Issues: 0
  • Pull requests: 23
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.22
  • Merged pull requests: 19
  • Bot issues: 0
  • Bot pull requests: 23
Top Authors
Issue Authors
  • bennibolm (1)
  • sloede (1)
  • JuliaTagBot (1)
Pull Request Authors
  • dependabot[bot] (45)
  • bennibolm (12)
  • sloede (12)
  • ranocha (2)
Top Labels
Issue Labels
documentation (1) visualization (1)
Pull Request Labels
dependencies (45) github_actions (12)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
juliahub.com: Smesh

Smesh.jl is a lightweight wrapper of the Fortran package smesh for generation and handling of unstructured meshes

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 9.9%
Average: 24.8%
Dependent packages count: 39.7%
Last synced: 9 months ago

Dependencies

.github/workflows/CompatHelper.yml actions
  • julia-actions/setup-julia v1 composite
.github/workflows/Documenter.yml actions
  • actions/checkout v4 composite
  • julia-actions/julia-buildpkg v1 composite
  • julia-actions/setup-julia v1 composite
.github/workflows/SpellCheck.yml actions
  • actions/checkout v4 composite
  • crate-ci/typos v1.17.2 composite
.github/workflows/TagBot.yml actions
  • JuliaRegistries/TagBot v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v3 composite
  • coverallsapp/github-action master 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 v1 composite
  • mxschmitt/action-tmate v3 composite