-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into jc/prep_DGMulti_noncons_for_shock_capturing
- Loading branch information
Showing
710 changed files
with
55,954 additions
and
20,416 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
### Review checklist | ||
|
||
This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging. | ||
|
||
#### Purpose and scope | ||
- [ ] The PR has a single goal that is clear from the PR title and/or description. | ||
- [ ] All code changes represent a single set of modifications that logically belong together. | ||
- [ ] No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs. | ||
|
||
#### Code quality | ||
- [ ] The code can be understood easily. | ||
- [ ] Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions. | ||
- [ ] There are no redundancies that can be removed by simple modularization/refactoring. | ||
- [ ] There are no leftover debug statements or commented code sections. | ||
- [ ] The code adheres to our [conventions](https://trixi-framework.github.io/Trixi.jl/stable/conventions/) and [style guide](https://trixi-framework.github.io/Trixi.jl/stable/styleguide/), and to the [Julia guidelines](https://docs.julialang.org/en/v1/manual/style-guide/). | ||
|
||
#### Documentation | ||
- [ ] New functions and types are documented with a docstring or top-level comment. | ||
- [ ] 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`. | ||
|
||
#### Testing | ||
- [ ] The PR passes all tests. | ||
- [ ] New or modified lines of code are covered by tests. | ||
- [ ] New or modified tests run in less then 10 seconds. | ||
|
||
#### Performance | ||
- [ ] There are no type instabilities or memory allocations in performance-critical parts. | ||
- [ ] If the PR intent is to improve performance, before/after [time measurements](https://trixi-framework.github.io/Trixi.jl/stable/performance/#Manual-benchmarking) are posted in the PR. | ||
|
||
#### Verification | ||
- [ ] The correctness of the code was verified using appropriate tests. | ||
- [ ] 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.* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
name: Downgrade | ||
|
||
on: | ||
pull_request: | ||
paths-ignore: | ||
- 'AUTHORS.md' | ||
- 'CITATION.bib' | ||
- 'CONTRIBUTING.md' | ||
- 'LICENSE.md' | ||
- 'NEWS.md' | ||
- 'README.md' | ||
- '.zenodo.json' | ||
- '.github/workflows/benchmark.yml' | ||
- '.github/workflows/CompatHelper.yml' | ||
- '.github/workflows/TagBot.yml' | ||
- 'benchmark/**' | ||
- 'docs/**' | ||
- 'utils/**' | ||
workflow_dispatch: | ||
|
||
# Cancel redundant CI tests automatically | ||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
downgrade_test: | ||
if: "!contains(github.event.head_commit.message, 'skip ci')" | ||
# We could also include the Julia version as in | ||
# name: ${{ matrix.trixi_test }} - ${{ matrix.os }} - Julia ${{ matrix.version }} - ${{ matrix.arch }} - ${{ github.event_name }} | ||
# to be more specific. However, that requires us updating the required CI tests whenever we update Julia. | ||
name: Downgrade ${{ matrix.trixi_test }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }} | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
version: | ||
- '1.9' | ||
# - '~1.9.0-0' # including development versions | ||
# - 'nightly' | ||
os: | ||
- ubuntu-latest | ||
arch: | ||
- x64 | ||
trixi_test: | ||
# - tree_part1 | ||
# - tree_part2 | ||
# - tree_part3 | ||
# - tree_part4 | ||
# - tree_part5 | ||
# - tree_part6 | ||
# - structured | ||
# - p4est_part1 | ||
# - p4est_part2 | ||
# - t8code_part1 | ||
# - unstructured_dgmulti | ||
# - parabolic | ||
# - paper_self_gravitating_gas_dynamics | ||
# - misc_part1 | ||
# - misc_part2 | ||
# - performance_specializations_part1 | ||
# - performance_specializations_part2 | ||
# - mpi | ||
- threaded | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: julia-actions/setup-julia@v1 | ||
with: | ||
version: ${{ matrix.version }} | ||
arch: ${{ matrix.arch }} | ||
- run: julia -e 'using InteractiveUtils; versioninfo(verbose=true)' | ||
- uses: julia-actions/cache@v1 | ||
- uses: julia-actions/julia-downgrade-compat@v1 | ||
with: | ||
skip: LinearAlgebra,Printf,SparseArrays,DiffEqBase | ||
projects: ., test | ||
- uses: julia-actions/julia-buildpkg@v1 | ||
env: | ||
PYTHON: "" | ||
- name: Run tests without coverage | ||
uses: julia-actions/julia-runtest@v1 | ||
with: | ||
coverage: false | ||
env: | ||
PYTHON: "" | ||
TRIXI_TEST: ${{ matrix.trixi_test }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
name: Add review checklist | ||
|
||
on: | ||
pull_request_target: | ||
types: [opened] | ||
|
||
permissions: | ||
pull-requests: write | ||
|
||
jobs: | ||
add-review-checklist: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Check out repository | ||
uses: actions/checkout@v4 | ||
- name: Add review checklist | ||
uses: trixi-framework/add-pr-review-checklist@v1 | ||
with: | ||
file: '.github/review-checklist.md' | ||
no-checklist-keyword: '[no checklist]' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.