diff --git a/.github/review-checklist.md b/.github/review-checklist.md index 2d8a24f1971..69410a07011 100644 --- a/.github/review-checklist.md +++ b/.github/review-checklist.md @@ -19,7 +19,7 @@ This checklist is meant to assist creators of PRs (to let them know what reviewe - [ ] Relevant publications are referenced in docstrings (see [example](https://github.com/trixi-framework/Trixi.jl/blob/7f83a1a938eecd9b841efe215a6e482e67cfdcc1/src/equations/compressible_euler_2d.jl#L601-L615) for formatting). - [ ] Inline comments are used to document longer or unusual code sections. - [ ] Comments describe intent ("why?") and not just functionality ("what?"). -- [ ] If the PR introduces a significant change or new feature, it is documented in `NEWS.md`. +- [ ] If the PR introduces a significant change or new feature, it is documented in `NEWS.md` with its PR number. #### Testing - [ ] The PR passes all tests. @@ -35,4 +35,4 @@ This checklist is meant to assist creators of PRs (to let them know what reviewe - [ ] If new equations/methods are added, a convergence test has been run and the results are posted in the PR. -*Created with :heart: by the Trixi.jl community.* \ No newline at end of file +*Created with :heart: by the Trixi.jl community.* diff --git a/NEWS.md b/NEWS.md index 0b4279e9e7a..e2902229f71 100644 --- a/NEWS.md +++ b/NEWS.md @@ -8,11 +8,11 @@ for human readability. #### Added - Implementation of `TimeSeriesCallback` for curvilinear meshes on `UnstructuredMesh2D` and extension - to 1D and 3D on `TreeMesh`. -- Implementation of 1D Linearized Euler Equations. -- New analysis callback for 2D `P4estMesh` to compute integrated quantities along a boundary surface, e.g., pressure lift and drag coefficients. -- Optional tuple parameter for `GlmSpeedCallback` called `semi_indices` to specify for which semidiscretization of a `SemidiscretizationCoupled` we need to update the GLM speed. -- Subcell local one-sided limiting support for nonlinear variables in 2D for `TreeMesh`. + to 1D and 3D on `TreeMesh` ([#1855], [#1873]). +- Implementation of 1D Linearized Euler Equations ([#1867]). +- New analysis callback for 2D `P4estMesh` to compute integrated quantities along a boundary surface, e.g., pressure lift and drag coefficients ([#1812]). +- Optional tuple parameter for `GlmSpeedCallback` called `semi_indices` to specify for which semidiscretization of a `SemidiscretizationCoupled` we need to update the GLM speed ([#1835]). +- Subcell local one-sided limiting support for nonlinear variables in 2D for `TreeMesh` ([#1792]). ## Changes when updating to v0.7 from v0.6.x @@ -190,9 +190,8 @@ for human readability. #### Added - Experimental support for artificial neural network-based indicators for shock capturing and - adaptive mesh refinement ([#632](https://github.com/trixi-framework/Trixi.jl/pull/632)) -- Experimental support for direct-hybrid aeroacoustics simulations - ([#712](https://github.com/trixi-framework/Trixi.jl/pull/712)) + adaptive mesh refinement ([#632]) +- Experimental support for direct-hybrid aeroacoustics simulations ([#712]) - Implementation of shallow water equations in 2D - Experimental support for interactive visualization with [Makie.jl](https://makie.juliaplots.org/) @@ -228,7 +227,7 @@ for human readability. - acoustic perturbation equations - Lattice-Boltzmann equations - Composable `FluxPlusDissipation` and `FluxLaxFriedrichs()`, `FluxHLL()` with adaptable - wave speed estimates were added in [#493](https://github.com/trixi-framework/Trixi.jl/pull/493) + wave speed estimates were added in [#493] - New structured, curvilinear, conforming mesh type `StructuredMesh` - New unstructured, curvilinear, conforming mesh type `UnstructuredMesh2D` in 2D - New unstructured, curvilinear, adaptive (non-conforming) mesh type `P4estMesh` in 2D and 3D @@ -241,13 +240,13 @@ for human readability. - `flux_lax_friedrichs(u_ll, u_rr, orientation, equations::LatticeBoltzmannEquations2D)` and `flux_lax_friedrichs(u_ll, u_rr, orientation, equations::LatticeBoltzmannEquations3D)` were actually using the logic of `flux_godunov`. Thus, they were renamed accordingly - in [#493](https://github.com/trixi-framework/Trixi.jl/pull/493). This is considered a bugfix + in [#493]. This is considered a bugfix (released in Trixi.jl v0.3.22). - The required Julia version is updated to v1.6. #### Deprecated -- `calcflux` → `flux` ([#463](https://github.com/trixi-framework/Trixi.jl/pull/463)) +- `calcflux` → `flux` ([#463]) - `flux_upwind` → `flux_godunov` - `flux_hindenlang` → `flux_hindenlang_gassner` - Providing the keyword argument `solution_variables` of `SaveSolutionCallback` @@ -259,6 +258,6 @@ for human readability. only a single two-point numerical flux for nonconservative is deprecated. The new interface is described in a tutorial. Now, a tuple of two numerical fluxes of the form `(conservative_flux, nonconservative_flux)` needs to be passed for - nonconservative equations, see [#657](https://github.com/trixi-framework/Trixi.jl/pull/657). + nonconservative equations, see [#657]. #### Removed diff --git a/docs/.gitignore b/docs/.gitignore index c8a9e842246..cc6f90fae09 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,3 +1,4 @@ +src/changelog.md src/code_of_conduct.md src/contributing.md diff --git a/docs/Project.toml b/docs/Project.toml index 3b8d169fdb8..9f9bb956274 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,5 +1,6 @@ [deps] CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0" +Changelog = "5217a498-cd5d-4ec6-b8c2-9b85a09b6e3e" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210" HOHQMesh = "e4f4c7b8-17cb-445a-93c5-f69190ed6c8c" @@ -14,6 +15,7 @@ TrixiBase = "9a0f1c46-06d5-4909-a5a3-ce25d3fa3284" [compat] CairoMakie = "0.6, 0.7, 0.8, 0.9, 0.10, 0.11" +Changelog = "1.1" Documenter = "1" ForwardDiff = "0.10" HOHQMesh = "0.1, 0.2" diff --git a/docs/make.jl b/docs/make.jl index 50251024262..73ee86abd8d 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,5 +1,6 @@ using Documenter import Pkg +using Changelog: Changelog # Fix for https://github.com/trixi-framework/Trixi.jl/issues/668 if (get(ENV, "CI", nothing) != "true") && (get(ENV, "TRIXI_DOC_DEFAULT_ENVIRONMENT", nothing) != "true") @@ -99,6 +100,14 @@ files = [ ] tutorials = create_tutorials(files) +# Create changelog +Changelog.generate( + Changelog.Documenter(), # output type + joinpath(@__DIR__, "..", "NEWS.md"), # input file + joinpath(@__DIR__, "src", "changelog.md"); # output file + repo = "trixi-framework/Trixi.jl", # default repository for links +) + # Make documentation makedocs( # Specify modules for which docstrings should be shown @@ -151,6 +160,7 @@ makedocs( "TrixiBase.jl" => "reference-trixibase.md", "Trixi2Vtk.jl" => "reference-trixi2vtk.md" ], + "Changelog" => "changelog.md", "Authors" => "authors.md", "Contributing" => "contributing.md", "Code of Conduct" => "code_of_conduct.md",