Merge branch 'subcell-limiting-entropies' into subcell-limiting-entro…

…pies-new-version

.github/workflows/FormatCheck.yml

@@ -29,7 +29,7 @@ jobs:
         # TODO: Change the call below to
         #       format(".")
         run: |
-          julia  -e 'using Pkg; Pkg.add(PackageSpec(name = "JuliaFormatter"))'
+          julia  -e 'using Pkg; Pkg.add(PackageSpec(name = "JuliaFormatter", version="1.0.45"))'
           julia  -e 'using JuliaFormatter; format(["benchmark", "examples", "ext", "src", "test", "utils"])'
       - name: Format check
         run: |

.github/workflows/SpellCheck.yml

@@ -10,4 +10,4 @@ jobs:
       - name: Checkout Actions Repository
         uses: actions/checkout@v4
       - name: Check spelling
-        uses: crate-ci/typos@v1.16.26
+        uses: crate-ci/typos@v1.18.0

.github/workflows/benchmark.yml

@@ -26,7 +26,7 @@ jobs:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
           show-versioninfo: true
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         env:
           cache-name: cache-artifacts
         with:

.github/workflows/ci.yml

@@ -101,6 +101,10 @@ jobs:
             os: windows-latest
             arch: x64
             trixi_test: threaded
+          - version: '1.9'
+            os: macos-14
+            arch: arm64
+            trixi_test: threaded
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1
@@ -129,12 +133,13 @@ jobs:
       - uses: julia-actions/julia-processcoverage@v1
         with:
           directories: src,examples,ext
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         with:
           file: ./lcov.info
           flags: unittests
           name: codecov-umbrella
-          fail_ci_if_error: false
+          fail_ci_if_error: true
+          verbose: true
           token: ${{ secrets.CODECOV_TOKEN }}
       # The standard setup of Coveralls is just annoying for parallel builds, see, e.g.,
       # https://github.com/trixi-framework/Trixi.jl/issues/691
@@ -195,7 +200,7 @@ jobs:
           coverage = merge_coverage_counts(coverage)
           @show covered_lines, total_lines = get_summary(coverage)
           LCOV.writefile("./lcov.info", coverage)
-      - uses: coverallsapp/github-action@master
+      - uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           path-to-lcov: ./lcov.info

Project.toml

@@ -1,7 +1,7 @@
 name = "Trixi"
 uuid = "a7f1ee26-1774-49b1-8366-f1abc58fbfcb"
 authors = ["Michael Schlottke-Lakemper <[email protected]>", "Gregor Gassner <[email protected]>", "Hendrik Ranocha <[email protected]>", "Andrew R. Winters <[email protected]>", "Jesse Chan <[email protected]>"]
-version = "0.6.9-pre"
+version = "0.6.10-pre"
 
 [deps]
 CodeTracking = "da1fd8a2-8d9e-5ec2-8556-3022fb5608a2"
@@ -45,6 +45,7 @@ TimerOutputs = "a759f4b9-e2f1-59dc-863e-4aeb61b1ea8f"
 Triangulate = "f7e6ffb2-c36d-4f8f-a77e-16e897189344"
 TriplotBase = "981d1d27-644d-49a2-9326-4793e63143c3"
 TriplotRecipes = "808ab39a-a642-4abf-81ff-4cb34ebbffa3"
+TrixiBase = "9a0f1c46-06d5-4909-a5a3-ce25d3fa3284"
 
 [weakdeps]
 Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
@@ -68,7 +69,7 @@ LinearAlgebra = "1"
 LinearMaps = "2.7, 3.0"
 LoopVectorization = "0.12.118"
 MPI = "0.20"
-Makie = "0.19"
+Makie = "0.19, 0.20"
 MuladdMacro = "0.2.2"
 Octavian = "0.3.5"
 OffsetArrays = "1.3"
@@ -95,6 +96,7 @@ TimerOutputs = "0.5.7"
 Triangulate = "2.0"
 TriplotBase = "0.1"
 TriplotRecipes = "0.1"
+TrixiBase = "0.1.1"
 julia = "1.8"
 
 [extras]

benchmark/benchmarks.jl

@@ -55,5 +55,5 @@ let
   SUITE["latency"]["euler_2d"] = @benchmarkable run(
     `$(Base.julia_cmd()) -e 'using Trixi; trixi_include(joinpath(examples_dir(), "tree_2d_dgsem", "elixir_euler_kelvin_helmholtz_instability.jl"), tspan=(0.0, 1.0e-10), save_restart=TrivialCallback(), save_solution=TrivialCallback())'`) seconds=60
   SUITE["latency"]["mhd_2d"] = @benchmarkable run(
-    `$(Base.julia_cmd()) -e 'using Trixi; trixi_include(joinpath(examples_dir(), "tree_2d_dgsem", "elixir_mhd_blast_wave.jl"), tspan=(0.0, 1.0e-10), save_restart=TrivialCallback(), save_solution=TrivialCallback())'`) seconds=60
+    `$(Base.julia_cmd()) -e 'using Trixi; trixi_include(joinpath(examples_dir(), "tree_2d_dgsem", "elixir_mhd_blast_wave.jl"), tspan=(0.0, 1.0e-10), save_solution=TrivialCallback())'`) seconds=60
 end

docs/Project.toml

@@ -10,9 +10,10 @@ OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 Trixi2Vtk = "bc1476a1-1ca6-4cc3-950b-c312b255ff95"
+TrixiBase = "9a0f1c46-06d5-4909-a5a3-ce25d3fa3284"
 
 [compat]
-CairoMakie = "0.6, 0.7, 0.8, 0.9, 0.10"
+CairoMakie = "0.6, 0.7, 0.8, 0.9, 0.10, 0.11"
 Documenter = "1"
 ForwardDiff = "0.10"
 HOHQMesh = "0.1, 0.2"
@@ -23,3 +24,4 @@ OrdinaryDiffEq = "6.49.1"
 Plots = "1.9"
 Test = "1"
 Trixi2Vtk = "0.3"
+TrixiBase = "0.1.1"

docs/literate/src/files/first_steps/changing_trixi.jl

@@ -0,0 +1,77 @@
+#src # Changing Trixi.jl itself
+
+# If you plan on editing Trixi.jl itself, you can download Trixi.jl locally and run it from
+# the cloned directory.
+
+
+# ## Cloning Trixi.jl
+
+
+# ### Windows
+
+# If you are using Windows, you can clone Trixi.jl by using the GitHub Desktop tool:
+# - If you do not have a GitHub account yet, create it on
+#   the [GitHub website](https://github.com/join).
+# - Download and install [GitHub Desktop](https://desktop.github.com/) and then log in to
+#   your account.
+# - Open GitHub Desktop, press `Ctrl+Shift+O`.
+# - In the opened window, paste `trixi-framework/Trixi.jl` and choose the path to the folder where
+#   you want to save Trixi.jl. Then click `Clone` and Trixi.jl will be cloned to your computer. 
+
+# Now you cloned Trixi.jl and only need to tell Julia to use the local clone as the package sources:
+# - Open a terminal using `Win+r` and `cmd`. Navigate to the folder with the cloned Trixi.jl using `cd`.
+# - Create a new directory `run`, enter it, and start Julia with the `--project=.` flag:
+#   ```shell
+#   mkdir run 
+#   cd run
+#   julia --project=.
+#   ```
+# - Now run the following commands to install all relevant packages:
+#   ```julia
+#   using Pkg; Pkg.develop(PackageSpec(path="..")) # Tell Julia to use the local Trixi.jl clone
+#   Pkg.add(["OrdinaryDiffEq", "Plots"])  # Install additional packages
+#   ```
+
+# Now you already installed Trixi.jl from your local clone. Note that if you installed Trixi.jl
+# this way, you always have to start Julia with the `--project` flag set to your `run` directory,
+# e.g.,
+# ```shell
+# julia --project=.
+# ```
+# if already inside the `run` directory.
+
+
+# ### Linux
+
+# You can clone Trixi.jl to your computer by executing the following commands:
+# ```shell
+# git clone [email protected]:trixi-framework/Trixi.jl.git 
+# # If an error occurs, try the following:
+# # git clone https://github.com/trixi-framework/Trixi.jl
+# cd Trixi.jl
+# mkdir run 
+# cd run
+# julia --project=. -e 'using Pkg; Pkg.develop(PackageSpec(path=".."))' # Tell Julia to use the local Trixi.jl clone
+# julia --project=. -e 'using Pkg; Pkg.add(["OrdinaryDiffEq", "Plots"])' # Install additional packages
+# ```
+# Note that if you installed Trixi.jl this way,
+# you always have to start Julia with the `--project` flag set to your `run` directory, e.g.,
+# ```shell
+# julia --project=.
+# ```
+# if already inside the `run` directory.
+
+
+# ## Additional reading
+
+# To further delve into Trixi.jl, you may have a look at the following introductory tutorials.
+# - [Introduction to DG methods](@ref scalar_linear_advection_1d) will teach you how to set up a
+#   simple way to approximate the solution of a hyperbolic partial differential equation. It will
+#   be especially useful to learn about the 
+#   [Discontinuous Galerkin method](https://en.wikipedia.org/wiki/Discontinuous_Galerkin_method)
+#   and the way it is implemented in Trixi.jl.
+# - [Adding a new scalar conservation law](@ref adding_new_scalar_equations) and
+#   [Adding a non-conservative equation](@ref adding_nonconservative_equation)
+#   describe how to add new physics models that are not yet included in Trixi.jl.
+# - [Callbacks](@ref callbacks-id) gives an overview of how to regularly execute specific actions
+#   during a simulation, e.g., to store the solution or adapt the mesh.