Merge branch 'main' into compathelper/new_version/2024-07-18-14-54-06…

…-813-04280782832
trixi-framework · Jul 25, 2024 · 3a7f778 · 3a7f778
2 parents 65c07dc + 32fa7c7
commit 3a7f778
Show file tree

Hide file tree

Showing 11 changed files with 1,202 additions and 27 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -48,21 +48,31 @@ jobs:
           show-versioninfo: true
       - uses: julia-actions/cache@v2
 
-      - name: Run tests
+      - name: Run tests without coverage
+        if: ${{ matrix.os != 'ubuntu-latest' }}
+        uses: julia-actions/julia-runtest@v1
+        with:
+          coverage: false
+
+      - name: Run tests with coverage
+        if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: julia-actions/julia-runtest@v1
         with:
           coverage: true
 
       - name: Process Julia coverage data
+        if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: julia-actions/julia-processcoverage@v1
 
       - name: Upload coverage data (Codecov)
+        if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: codecov/codecov-action@v4
         with:
           files: lcov.info
           token: ${{ secrets.CODECOV_TOKEN }}
 
       - name: Upload coverage data (Coveralls)
+        if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/Project.toml b/Project.toml
@@ -6,13 +6,15 @@ version = "0.1.0-DEV"
 [deps]
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 MuladdMacro = "46d2c3a1-f734-5fdb-9937-b9b9aeba4221"
+Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Static = "aedffcd0-7271-4cad-89d0-dc628f76c6d3"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Trixi = "a7f1ee26-1774-49b1-8366-f1abc58fbfcb"
 
 [compat]
 LinearAlgebra = "1"
 MuladdMacro = "0.2.2"
+Reexport = "1.0"
 Static = "0.8, 1"
 StaticArrays = "1"
 Trixi = "0.7, 0.8"

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 -->
 [![Docs-dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://trixi-framework.github.io/TrixiAtmo.jl/dev)
 [![Slack](https://img.shields.io/badge/chat-slack-e01e5a)](https://join.slack.com/t/trixi-framework/shared_invite/zt-sgkc6ppw-6OXJqZAD5SPjBYqLd8MU~g)
-[![Build Status](https://github.com/trixi-framework/TrixiAtmo.jl/workflows/CI/badge.svg)](https://github.com/trixi-framework/TrixiAtmo.jl/actions?query=workflow%3ACI)
+[![Build Status](https://github.com/trixi-framework/TrixiAtmo.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/trixi-framework/TrixiAtmo.jl/actions?query=workflow%3ACI)
 [![Codecov](https://codecov.io/gh/trixi-framework/TrixiAtmo.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/trixi-framework/TrixiAtmo.jl)
 [![Coveralls](https://coveralls.io/repos/github/trixi-framework/TrixiAtmo.jl/badge.svg?branch=main)](https://coveralls.io/github/trixi-framework/TrixiAtmo.jl?branch=main)
 [![License: MIT](https://img.shields.io/badge/License-MIT-success.svg)](https://opensource.org/licenses/MIT)

diff --git a/src/TrixiAtmo.jl b/src/TrixiAtmo.jl
@@ -9,17 +9,20 @@ See also: [trixi-framework/TrixiAtmo.jl](https://github.com/trixi-framework/Trix
 module TrixiAtmo
 
 using Trixi
-# Import additional symbols that are not exported by Trixi.jl
-# using Trixi:
 using MuladdMacro: @muladd
 using StaticArrays: SVector
 using Static: True, False
 using LinearAlgebra: norm
+using Reexport: @reexport
+@reexport using StaticArrays: SVector
 
-foo() = true
-bar() = false
-baz() = Trixi.examples_dir()
-
+include("auxiliary/auxiliary.jl")
 include("equations/equations.jl")
 
+export CompressibleMoistEulerEquations2D
+
+export flux_chandrashekar, flux_LMARS
+
+export examples_dir
+
 end # module TrixiAtmo
diff --git a/src/auxiliary/auxiliary.jl b/src/auxiliary/auxiliary.jl
@@ -0,0 +1,14 @@
+"""
+    examples_dir()
+
+Return the directory where the example files provided with TrixiAtmo.jl are located.
+If TrixiAtmo.jl is installed as a regular package (with `]add Trixi`), these files are
+read-only and should *not* be modified.
+To find out which files are available, use, e.g., `readdir`:
+
+# Examples
+```@example
+readdir(examples_dir())
+```
+"""
+examples_dir() = pkgdir(TrixiAtmo, "examples")