Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use registered HOHQMesh_jll #6

Merged
merged 7 commits into from
Jun 16, 2021
Merged

Use registered HOHQMesh_jll #6

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d01884f
remove manifest
sloede Jun 15, 2021
695924a
Update README for HOHQMesh being a registered package
sloede Jun 15, 2021
e1ef348
Reomve special CI code for HOHQMesh_jll as an unregistered package
sloede Jun 15, 2021
825c5d8
Make `stable` the default documentation URL
sloede Jun 15, 2021
adfd75f
Add compat for HOHQMesh_jll
sloede Jun 16, 2021
3452146
Add URL to HOHQMesh_jll and fix whitespace error
sloede Jun 16, 2021
a8d3a57
Remove JLL dependencies from docs
sloede Jun 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions .github/workflows/Documenter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
134 changes: 0 additions & 134 deletions Manifest.toml
View file
Open in desktop

This file was deleted.

3 changes: 3 additions & 0 deletions Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ version = "0.1.0-pre"

[deps]
HOHQMesh_jll = "1d5cbd98-5122-5a8a-bea1-c186d986ee7f"

[compat]
julia = "1.6"
sloede marked this conversation as resolved.
Show resolved Hide resolved
43 changes: 21 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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-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
sloede marked this conversation as resolved.
Show resolved Hide resolved
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
sloede marked this conversation as resolved.
Show resolved Hide resolved
mesh for them by executing
```julia
julia> control_file = joinpath(HOHQMesh.examples_dir(), "GingerbreadMan.control")

Expand All @@ -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.
2 changes: 1 addition & 1 deletion docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down
41 changes: 20 additions & 21 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,36 @@
# HOHQMesh.jl
sloede marked this conversation as resolved.
Show resolved Hide resolved

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")

Expand All @@ -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.