Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trixi-framework/smesh.jl
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
Last synced: about 1 month ago
JSON representation
Smesh.jl is a lightweight wrapper of the Fortran package smesh for generation and handling of unstructured meshes
- Host: GitHub
- URL: https://github.com/trixi-framework/smesh.jl
- Owner: trixi-framework
- License: mit
- Created: 2024-01-25T07:48:51.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-11-01T23:51:30.000Z (about 2 months ago)
- Last Synced: 2024-11-03T11:08:33.184Z (about 2 months ago)
- Language: Julia
- Homepage: https://trixi-framework.github.io/Smesh.jl/
- Size: 389 KB
- Stars: 2
- Watchers: 9
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Citation: CITATION.bib
- Security: SECURITY.md
Awesome Lists containing this project
README
# Smesh.jl
[](https://trixi-framework.github.io/Smesh.jl/stable)
[](https://trixi-framework.github.io/Smesh.jl/dev)
[](https://github.com/trixi-framework/Smesh.jl/actions?query=workflow%3ACI)
[](https://coveralls.io/github/trixi-framework/Smesh.jl)
[](https://codecov.io/gh/trixi-framework/Smesh.jl)
[](https://opensource.org/license/mit/)
[](https://doi.org/10.5281/zenodo.10581816)
Smesh.jl is a Julia wrapper packagae for [smesh](https://github.com/trixi-framework/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](https://julialang.org/downloads/platform/).
[Smesh.jl](https://github.com/trixi-framewor/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 = "/lib/libsmesh.so"
```
* On macOS:
```toml
[Smesh]
libsmesh = "/lib/libsmesh.dylib"
```
* On Windows:
```toml
[Smesh]
libsmesh = "/bin/libsmesh.dll"
```
Where `` 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`](https://github.com/trixi-framework/Smesh.jl/tree/main/examples) directory by
`include`ing them in Julia, e.g.,
```
julia> using Smesh
julia> include(joinpath(pkgdir(Smesh), "examples", "build_delaunay_triangulation.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](https://github.com/trixi-framework/smesh) (`doi:10.5281/zenodo.10579422`) itself.
## Authors
Smesh.jl was initiated by
[Simone Chiocchetti](https://www.mi.uni-koeln.de/NumSim/dr-simone-chiocchetti/)
(University of Cologne, Germany),
[Benjamin Bolm](https://www.mi.uni-koeln.de/NumSim/benjamin-bolm/)
(University of Cologne, Germany), and
[Michael Schlottke-Lakemper](https://lakemper.eu) (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](LICENSE.md)).
Contributions by the community are very welcome!