From 7e6ea2a3142bb461edd5953aa33d56a53e81686e Mon Sep 17 00:00:00 2001 From: Spencer Bryngelson Date: Sun, 11 Feb 2024 18:54:28 -0500 Subject: [PATCH] Some rearranging of MFC docs (#337) --- .../CODE_OF_CONDUCT.md | 0 .../pull_request_template.md | 35 -------------- .github/pull_request_template.md | 47 +++++++++++++++++++ LICENSE | 2 +- 4 files changed, 48 insertions(+), 36 deletions(-) rename {docs/documentation => .github}/CODE_OF_CONDUCT.md (100%) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md create mode 100644 .github/pull_request_template.md diff --git a/docs/documentation/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 100% rename from docs/documentation/CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md deleted file mode 100644 index 6f446dd8e..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ /dev/null @@ -1,35 +0,0 @@ -# Description - -Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) - -## Type of change - -Please delete options that are not relevant. - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] This change requires a documentation update - -# How Has This Been Tested? - -Please describe the tests that you ran to verify your changes. -Provide instructions so we can reproduce. -Please also list any relevant details for your test configuration - -- [ ] Test A -- [ ] Test B - -**Test Configuration**: -* What computers and compilers did you use to test this: - -# Checklist: - -- [ ] I have performed a self-review of my code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing tests pass locally with my changes -- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..b5ffe3311 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,47 @@ +## Description + +Please include a summary of the changes and the related issue(s) if they exist. +Please also include relevant motivation and context. + +Fixes #(issue) [optional] + +### Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Something else + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. +Provide instructions so we can reproduce. +Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +**Test Configuration**: + +* What computers and compilers did you use to test this: + +## Checklist: + +- [ ] I have added comments for new code +- [ ] I added Doxygen docstrings to new code +- [ ] I have made corresponding changes to the documentation (`docs/`) +- [ ] I have added regression tests to the test suite so that people can verify in the future that the feature is behaving as expected +- [ ] I have added example cases in `examples/` that demonstrate my new feature performing as expected +- [ ] New and existing tests pass locally with my changes, including with GPU capability enabled and disabled +- [ ] This PR does not introduce any repeated code (it follows the [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) principle) +- [ ] I cannot think of a way to condense this code and reduce any introduced additional line count + +### If your code changes any code source files (anything in `src/`) + +To make sure the code is performing as expected on GPU devices, I have: +- [ ] Checked that the code compiles using NVHPC compilers +- [ ] Ran the code on either V100, A100, or H100 GPUs and ensured the new feature performed as expected (the GPU results match the CPU results) +- [ ] Enclosed the new feature via `nvtx` ranges so that they can be identified in profiles +- [ ] Ran a Nsight Systems profile using `./mfc.sh run XXXX --gpu -t simulation --nsys`, and have attached the output file (`.nsys-rep`) and plain text results to this PR +- [ ] Ran my code using various numbers of different GPUs (1, 2, and 8, for example) in parallel and made sure that the results scale similarly to what happens if you run without the new code/feature diff --git a/LICENSE b/LICENSE index d79195197..dbc61e6e5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Spencer Bryngelson, Tim Colonius +Copyright (c) 2021-2024 Spencer Bryngelson, Tim Colonius Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: