From d01884f5d449457947f2e2daf249e992418d98dc Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Tue, 15 Jun 2021 23:37:46 +0200 Subject: [PATCH 1/7] remove manifest --- Manifest.toml | 134 -------------------------------------------------- Project.toml | 3 ++ 2 files changed, 3 insertions(+), 134 deletions(-) delete mode 100644 Manifest.toml diff --git a/Manifest.toml b/Manifest.toml deleted file mode 100644 index 1c2c3d0f..00000000 --- a/Manifest.toml +++ /dev/null @@ -1,134 +0,0 @@ -# This file is machine-generated - editing it directly is not advised - -[[ArgTools]] -uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f" - -[[Artifacts]] -uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33" - -[[Base64]] -uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" - -[[CompilerSupportLibraries_jll]] -deps = ["Artifacts", "Libdl"] -uuid = "e66e0078-7015-5450-92f7-15fbd957f2ae" - -[[Dates]] -deps = ["Printf"] -uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" - -[[Downloads]] -deps = ["ArgTools", "LibCURL", "NetworkOptions"] -uuid = "f43a241f-c20a-4ad4-852c-f6b1247861c6" - -[[HOHQMesh_jll]] -deps = ["Artifacts", "CompilerSupportLibraries_jll", "JLLWrappers", "Libdl", "Pkg"] -git-tree-sha1 = "c95123aaf533b4373e94f7309cb167767788c726" -repo-rev = "main" -repo-url = "https://github.com/trixi-framework/HOHQMesh_jll.jl" -uuid = "1d5cbd98-5122-5a8a-bea1-c186d986ee7f" -version = "13.0.3-track.5.3.21+0" - -[[InteractiveUtils]] -deps = ["Markdown"] -uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" - -[[JLLWrappers]] -deps = ["Preferences"] -git-tree-sha1 = "642a199af8b68253517b80bd3bfd17eb4e84df6e" -uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210" -version = "1.3.0" - -[[LibCURL]] -deps = ["LibCURL_jll", "MozillaCACerts_jll"] -uuid = "b27032c2-a3e7-50c8-80cd-2d36dbcbfd21" - -[[LibCURL_jll]] -deps = ["Artifacts", "LibSSH2_jll", "Libdl", "MbedTLS_jll", "Zlib_jll", "nghttp2_jll"] -uuid = "deac9b47-8bc7-5906-a0fe-35ac56dc84c0" - -[[LibGit2]] -deps = ["Base64", "NetworkOptions", "Printf", "SHA"] -uuid = "76f85450-5226-5b5a-8eaa-529ad045b433" - -[[LibSSH2_jll]] -deps = ["Artifacts", "Libdl", "MbedTLS_jll"] -uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8" - -[[Libdl]] -uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb" - -[[Logging]] -uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" - -[[Markdown]] -deps = ["Base64"] -uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" - -[[MbedTLS_jll]] -deps = ["Artifacts", "Libdl"] -uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1" - -[[MozillaCACerts_jll]] -uuid = "14a3606d-f60d-562e-9121-12d972cd8159" - -[[NetworkOptions]] -uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908" - -[[Pkg]] -deps = ["Artifacts", "Dates", "Downloads", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "REPL", "Random", "SHA", "Serialization", "TOML", "Tar", "UUIDs", "p7zip_jll"] -uuid = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f" - -[[Preferences]] -deps = ["TOML"] -git-tree-sha1 = "ea79e4c9077208cd3bc5d29631a26bc0cff78902" -uuid = "21216c6a-2e73-6563-6e65-726566657250" -version = "1.2.1" - -[[Printf]] -deps = ["Unicode"] -uuid = "de0858da-6303-5e67-8744-51eddeeeb8d7" - -[[REPL]] -deps = ["InteractiveUtils", "Markdown", "Sockets", "Unicode"] -uuid = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb" - -[[Random]] -deps = ["Serialization"] -uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" - -[[SHA]] -uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" - -[[Serialization]] -uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" - -[[Sockets]] -uuid = "6462fe0b-24de-5631-8697-dd941f90decc" - -[[TOML]] -deps = ["Dates"] -uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76" - -[[Tar]] -deps = ["ArgTools", "SHA"] -uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e" - -[[UUIDs]] -deps = ["Random", "SHA"] -uuid = "cf7118a7-6976-5b1a-9a39-7adc72f591a4" - -[[Unicode]] -uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" - -[[Zlib_jll]] -deps = ["Libdl"] -uuid = "83775a58-1f1d-513f-b197-d71354ab007a" - -[[nghttp2_jll]] -deps = ["Artifacts", "Libdl"] -uuid = "8e850ede-7688-5339-a07c-302acd2aaf8d" - -[[p7zip_jll]] -deps = ["Artifacts", "Libdl"] -uuid = "3f19e933-33d8-53b3-aaab-bd5110c3b7a0" diff --git a/Project.toml b/Project.toml index 6c9bd778..eb7f02d0 100644 --- a/Project.toml +++ b/Project.toml @@ -5,3 +5,6 @@ version = "0.1.0-pre" [deps] HOHQMesh_jll = "1d5cbd98-5122-5a8a-bea1-c186d986ee7f" + +[compat] +julia = "1.6" From 695924ae7ab0a71a17d5865c573480afe270807f Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Tue, 15 Jun 2021 23:39:22 +0200 Subject: [PATCH 2/7] Update README for HOHQMesh being a registered package --- README.md | 43 +++++++++++++++++++++---------------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 8e851267..9c720f9c 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,42 @@ # HOHQMesh.jl - +[![Docs-stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://trixi-framework.github.io/HOHQMesh.jl/stable) [![Docs-dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://trixi-framework.github.io/HOHQMesh.jl/dev) [![Build Status](https://github.com/trixi-framework/HOHQMesh.jl/workflows/CI/badge.svg)](https://github.com/trixi-framework/HOHQMesh.jl/actions?query=workflow%3ACI) [![Coveralls](https://coveralls.io/repos/github/trixi-framework/HOHQMesh.jl/badge.svg?branch=main)](https://coveralls.io/github/trixi-framework/HOHQMesh.jl?branch=main) [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT) This package is a thin Julia wrapper around the *High Order Hex-Quad Mesher* -(a.k.a. **HOHQMesh**) created and developed by +(a.k.a. [**HOHQMesh**](https://github.com/trixi-framework/HOHQMesh)) created and developed by [David A. Kopriva](https://www.math.fsu.edu/~kopriva/). HOHQMesh.jl is available on Linux, MacOS, and Windows. -**Note: This package is currently _highly_ experimental!** +## Installation +If you have not yet installed Julia, please [follow the instructions for your +operating system](https://julialang.org/downloads/platform/). HOHQMesh.jl works +with Julia v1.6. -## Getting started - -This package is still in proof-of-concept stage. Thus many things will not work -as convenient as they do for properly registered packages. - -To install HOHQMesh.jl, you need to manually install it *and its dependency* -[HOHQMesh_jll](https://github.com/trixi-framework/HOHQMESH_jll.jl) -by executing the following lines in your Julia REPL: +HOHQMesh.jl is a registered Julia package. Hence, you can install it by executing +the following commands in the Julia REPL: ```julia -julia> import Pkg - -julia> Pkg.add(url="https://github.com/trixi-framework/HOHQMESH_jll.jl") - -julia> Pkg.add(url="https://github.com/trixi-framework/HOHQMESH.jl") +julia> import Pkg; Pkg.add("HOHQMesh") ``` +HOHQMesh.jl depends on the binary distribution of the +[HOHQMesh](https://github.com/trixi-framework/HOHQMesh) +mesh generator, which is available via the Julia package `HOHQMesh_jll.jl` and +which is automatically installed as a dependency. -Afterwards, you can just load HOHQMesh with +## Usage +In the Julia REPL, you can load HOHQMesh with ```julia julia> using HOHQMesh ``` and then happily generate away! -Two 2D examples from HOHQMesh itself (`GingerbreadMan` or `NACA0012`) and a 3D -example (`Snake`) come delivered with this package. You can generate a mesh for -them by executing +Two 2D examples `GingerbreadMan` and `NACA0012` and a 3D example `Snake` (all + from HOHQMesh itself) come delivered with this package. You can generate a +mesh for them by executing ```julia julia> control_file = joinpath(HOHQMesh.examples_dir(), "GingerbreadMan.control") @@ -65,9 +63,10 @@ The *HOHQMesh* mesh generator itself is developed by ## License and contributing HOHQMesh.jl is licensed under the MIT license (see [LICENSE.md](LICENSE.md)). -*HOHQMesh* itself is not available as open source. +*HOHQMesh* itself is also available under the MIT license. ## Acknowledgements The authors would like to thank David A. Kopriva for making the sources of -*HOHQMesh* available to them, and for assisting with making it work with Julia. +*HOHQMesh* available as open source, and for assisting with making it work with +Julia. From e1ef3483782f1d07230e5aab2371412968b55a78 Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Tue, 15 Jun 2021 23:39:47 +0200 Subject: [PATCH 3/7] Reomve special CI code for HOHQMesh_jll as an unregistered package --- .github/workflows/Documenter.yml | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/workflows/Documenter.yml b/.github/workflows/Documenter.yml index 86a5693e..6d94197e 100644 --- a/.github/workflows/Documenter.yml +++ b/.github/workflows/Documenter.yml @@ -25,14 +25,9 @@ jobs: with: version: '1.6' - name: Install dependencies - run: | # FIXME: Remove run and use next one once JLL package is registered - julia --project=docs/ -e 'using Pkg; Pkg.develop(url="https://github.com/trixi-framework/HOHQMesh_jll.jl")' - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' - # run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' + run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' - name: Build and deploy env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key run: julia --project=docs --color=yes docs/make.jl - - name: Clean up docs/Project.toml - run: git restore docs/Project.toml From 825c5d87c1ee5cf39f78b10904aa9585354b251c Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Tue, 15 Jun 2021 23:40:22 +0200 Subject: [PATCH 4/7] Make `stable` the default documentation URL --- docs/make.jl | 2 +- docs/src/index.md | 41 ++++++++++++++++++++--------------------- 2 files changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 818c312b..a1594129 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -18,7 +18,7 @@ makedocs( # Explicitly add favicon as asset # assets = ["assets/favicon.ico"], # Set canonical URL to GitHub pages URL - canonical = "https://trixi-framework.github.io/HOHQMesh.jl/dev" + canonical = "https://trixi-framework.github.io/HOHQMesh.jl/stable" ), # Explicitly specify documentation structure pages = [ diff --git a/docs/src/index.md b/docs/src/index.md index 08094780..707b8ee4 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,38 +1,36 @@ # HOHQMesh.jl This package is a thin Julia wrapper around the *High Order Hex-Quad Mesher* -(a.k.a. **HOHQMesh**) created and developed by +(a.k.a. [**HOHQMesh**](https://github.com/trixi-framework/HOHQMesh)) created and developed by [David A. Kopriva](https://www.math.fsu.edu/~kopriva/). HOHQMesh.jl is available on Linux, MacOS, and Windows. -**Note: This package is currently _highly_ experimental!** +## Installation +If you have not yet installed Julia, please [follow the instructions for your +operating system](https://julialang.org/downloads/platform/). HOHQMesh.jl works +with Julia v1.6. -## Getting started - -This package is still in proof-of-concept stage. Thus many things will not work -as convenient as they do for properly registered packages. - -To install HOHQMesh.jl, you need to manually install it *and its dependency* -[HOHQMesh_jll](https://github.com/trixi-framework/HOHQMESH_jll.jl) -by executing the following lines in your Julia REPL: +HOHQMesh.jl is a registered Julia package. Hence, you can install it by executing +the following commands in the Julia REPL: ```julia -julia> import Pkg - -julia> Pkg.add(url="https://github.com/trixi-framework/HOHQMESH_jll.jl") - -julia> Pkg.add(url="https://github.com/trixi-framework/HOHQMESH.jl") +julia> import Pkg; Pkg.add("HOHQMesh") ``` +HOHQMesh.jl depends on the binary distribution of the +[HOHQMesh](https://github.com/trixi-framework/HOHQMesh) +mesh generator, which is available via the Julia package `HOHQMesh_jll.jl` and +which is automatically installed as a dependency. -Afterwards, you can just load HOHQMesh with +## Usage +In the Julia REPL, you can load HOHQMesh with ```julia julia> using HOHQMesh ``` and then happily generate away! -Two 2D examples from HOHQMesh itself (`GingerbreadMan` or `NACA0012`) and a 3D -example (`Snake`) come delivered with this package. You can generate a mesh for -them by executing +Two 2D examples `GingerbreadMan` and `NACA0012` and a 3D example `Snake` (all + from HOHQMesh itself) come delivered with this package. You can generate a +mesh for them by executing ```julia julia> control_file = joinpath(HOHQMesh.examples_dir(), "GingerbreadMan.control") @@ -59,9 +57,10 @@ The *HOHQMesh* mesh generator itself is developed by ## License and contributing HOHQMesh.jl is licensed under the MIT license (see [License](@ref)). -*HOHQMesh* itself is not available as open source. +*HOHQMesh* itself is also available under the MIT license. ## Acknowledgements The authors would like to thank David A. Kopriva for making the sources of -*HOHQMesh* available to them, and for assisting with making it work with Julia. +*HOHQMesh* available as open source, and for assisting with making it work with +Julia. From adfd75fba0ba950f94ec0d38e31fb5b0400610e9 Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Wed, 16 Jun 2021 06:40:55 +0200 Subject: [PATCH 5/7] Add compat for HOHQMesh_jll --- Project.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/Project.toml b/Project.toml index eb7f02d0..60747e89 100644 --- a/Project.toml +++ b/Project.toml @@ -7,4 +7,5 @@ version = "0.1.0-pre" HOHQMesh_jll = "1d5cbd98-5122-5a8a-bea1-c186d986ee7f" [compat] +HOHQMesh_jll = "1.0" julia = "1.6" From 345214648263c11bc3bf5006b4f08173ef0fbe77 Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Wed, 16 Jun 2021 06:45:33 +0200 Subject: [PATCH 6/7] Add URL to HOHQMesh_jll and fix whitespace error --- README.md | 7 ++++--- docs/src/index.md | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9c720f9c..f3fd132d 100644 --- a/README.md +++ b/README.md @@ -24,8 +24,9 @@ julia> import Pkg; Pkg.add("HOHQMesh") ``` HOHQMesh.jl depends on the binary distribution of the [HOHQMesh](https://github.com/trixi-framework/HOHQMesh) -mesh generator, which is available via the Julia package `HOHQMesh_jll.jl` and -which is automatically installed as a dependency. +mesh generator, which is available via the Julia package +[HOHQMesh_jll.jl](https://github.com/JuliaBinaryWrappers/HOHQMesh_jll.jl) +and which is automatically installed as a dependency. ## Usage In the Julia REPL, you can load HOHQMesh with @@ -35,7 +36,7 @@ julia> using HOHQMesh and then happily generate away! Two 2D examples `GingerbreadMan` and `NACA0012` and a 3D example `Snake` (all - from HOHQMesh itself) come delivered with this package. You can generate a +from HOHQMesh itself) come delivered with this package. You can generate a mesh for them by executing ```julia julia> control_file = joinpath(HOHQMesh.examples_dir(), "GingerbreadMan.control") diff --git a/docs/src/index.md b/docs/src/index.md index 707b8ee4..4afc0d97 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -18,8 +18,9 @@ julia> import Pkg; Pkg.add("HOHQMesh") ``` HOHQMesh.jl depends on the binary distribution of the [HOHQMesh](https://github.com/trixi-framework/HOHQMesh) -mesh generator, which is available via the Julia package `HOHQMesh_jll.jl` and -which is automatically installed as a dependency. +mesh generator, which is available via the Julia package +[HOHQMesh_jll.jl](https://github.com/JuliaBinaryWrappers/HOHQMesh_jll.jl) +and which is automatically installed as a dependency. ## Usage In the Julia REPL, you can load HOHQMesh with @@ -29,7 +30,7 @@ julia> using HOHQMesh and then happily generate away! Two 2D examples `GingerbreadMan` and `NACA0012` and a 3D example `Snake` (all - from HOHQMesh itself) come delivered with this package. You can generate a +from HOHQMesh itself) come delivered with this package. You can generate a mesh for them by executing ```julia julia> control_file = joinpath(HOHQMesh.examples_dir(), "GingerbreadMan.control") From a8d3a5765b02f1645caa2077a44235c51b7c2c90 Mon Sep 17 00:00:00 2001 From: Michael Schlottke-Lakemper Date: Wed, 16 Jun 2021 09:05:18 +0200 Subject: [PATCH 7/7] Remove JLL dependencies from docs --- docs/Project.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/Project.toml b/docs/Project.toml index f24d042a..101c2b61 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,6 +1,5 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -HOHQMesh_jll = "1d5cbd98-5122-5a8a-bea1-c186d986ee7f" [compat] Documenter = "0.26"