From 1cccd200d8fe8f13872faa5d9e130dd19286ee67 Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Tue, 30 Jan 2024 09:15:59 +0100 Subject: [PATCH 1/5] Add DOI (#10) --- .zenodo.json | 2 +- CITATION.bib | 8 ++++++++ README.md | 24 ++++++++++++++++++++---- 3 files changed, 29 insertions(+), 5 deletions(-) create mode 100644 CITATION.bib diff --git a/.zenodo.json b/.zenodo.json index 3583325..6bc050c 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -1,6 +1,6 @@ { "title": "Smesh.jl", - "description": "A Julia wrapper for the Fortran package smesh to generate and handle unstructured meshes ", + "description": "A Julia wrapper for the Fortran package smesh to generate and handle unstructured meshes", "license": "MIT", "upload_type": "software", "creators": [ diff --git a/CITATION.bib b/CITATION.bib new file mode 100644 index 0000000..fe28d5c --- /dev/null +++ b/CITATION.bib @@ -0,0 +1,8 @@ +@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} +} + diff --git a/README.md b/README.md index cc279b9..6e76a22 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Coveralls](https://coveralls.io/repos/github/trixi-framework/Smesh.jl/badge.svg)](https://coveralls.io/github/trixi-framework/Smesh.jl) [![Codecov](https://codecov.io/gh/trixi-framework/Smesh.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/trixi-framework/Smesh.jl) [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/license/mit/) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10581816.svg)](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 @@ -22,13 +23,13 @@ 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 not registered Julia package yet, you can install it by executing -the following commands in the Julia REPL: +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("https://github.com/trixi-framework/Smesh.jl") +julia> import Pkg; Pkg.add("Smesh") ``` -By default, Smesh.jll uses pre-compiled binaries of the smesh package that will get +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: @@ -72,6 +73,21 @@ Flips/node: 0.00 ``` +## 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/) From 45f05be5e1dd999fbb589612600f574c6dec1f9c Mon Sep 17 00:00:00 2001 From: Benjamin Bolm <74359358+bennibolm@users.noreply.github.com> Date: Tue, 30 Jan 2024 09:31:12 +0100 Subject: [PATCH 2/5] set version to v0.1.1 --- Project.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Project.toml b/Project.toml index 243e6b5..fea5a1c 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "Smesh" uuid = "e2b06280-edec-413c-a3a2-1b4e389db7bf" authors = ["Simone Chiocchetti ", "Benjamin Bolm ", "Michael Schlottke-Lakemper "] -version = "0.1.0" +version = "0.1.1" [deps] Preferences = "21216c6a-2e73-6563-6e65-726566657250" From f498238bf0e55e3706c3b6cd82ba2715b0e0a244 Mon Sep 17 00:00:00 2001 From: Benjamin Bolm <74359358+bennibolm@users.noreply.github.com> Date: Tue, 30 Jan 2024 09:50:44 +0100 Subject: [PATCH 3/5] set development version to v0.1.2-dev --- Project.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Project.toml b/Project.toml index fea5a1c..55e988c 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "Smesh" uuid = "e2b06280-edec-413c-a3a2-1b4e389db7bf" authors = ["Simone Chiocchetti ", "Benjamin Bolm ", "Michael Schlottke-Lakemper "] -version = "0.1.1" +version = "0.1.2-dev" [deps] Preferences = "21216c6a-2e73-6563-6e65-726566657250" From 98d15eece49be010fc3831ba173beb4183ee30c3 Mon Sep 17 00:00:00 2001 From: Benjamin Bolm <74359358+bennibolm@users.noreply.github.com> Date: Sat, 3 Feb 2024 11:31:46 +0100 Subject: [PATCH 4/5] Add codecov token to env (#13) --- .github/workflows/ci.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index df2113c..bbe023a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -68,6 +68,8 @@ jobs: with: files: lcov.info token: ${{ secrets.CODECOV_TOKEN }} + env: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} - uses: coverallsapp/github-action@master with: github-token: ${{ secrets.GITHUB_TOKEN }} From 3ccdfe1e7592dc84f91caeb1f454f3d3e50dca5f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 3 Feb 2024 11:35:51 +0100 Subject: [PATCH 5/5] Bump codecov/codecov-action from 3 to 4 (#11) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 3 to 4. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/codecov/codecov-action/compare/v3...v4) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bbe023a..4805df4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -64,7 +64,7 @@ jobs: - uses: julia-actions/julia-processcoverage@v1 with: directories: src,examples - - uses: codecov/codecov-action@v3 + - uses: codecov/codecov-action@v4 with: files: lcov.info token: ${{ secrets.CODECOV_TOKEN }}