Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: Bug report
about: Report a bug or unexpected behavior.
labels: [bug]
---

_Please remove any sensitive information (e.g., passwords, API keys) from your submission. Thank you for taking the time to report this issue. We will respond as soon as possible._

## Description
A clear and concise description of the bug.

## Expected behavior
What did you expect to happen when you encountered the issue?

## How to reproduce
Please provide (if available):
- WarpX inputs files
- PICMI Python files
- Python post-processing scripts

If you are unable to provide certain files or scripts, please describe the steps you took to encounter the issue.

Please minimize your inputs/scripts to be concise and focused on the issue.
For instance, make the simulation scripts as small and fast to run as possible.

## Error messages
Please paste any relevant error messages or console output.

## System information
Please check all relevant boxes and provide details.

- Operating System (name and version):
- [ ] Linux: e.g., Ubuntu 22.04 LTS
- [ ] macOS: e.g., macOS Monterey 12.4
- [ ] Windows: e.g., Windows 11 Pro
- Version of WarpX: e.g., latest, 24.10, etc.
- Installation method:
- [ ] Conda
- [ ] Spack
- [ ] PyPI
- [ ] Brew
- [ ] From source with CMake
- [ ] Module system on an HPC cluster
- Other dependencies: yes/no, describe
- Computational resources:
- [ ] MPI: e.g., 2 MPI processes
- [ ] OpenMP: e.g., 2 OpenMP threads
- [ ] CPU: e.g., 2 CPUs
- [ ] GPU: e.g., 2 GPUs (NVIDIA, AMD, etc.)

If you encountered the issue on an HPC cluster, please check our [HPC documentation](https://warpx.readthedocs.io/en/latest/install/hpc.html) to see if your HPC cluster is already supported.

## Steps taken so far
What troubleshooting steps have you taken so far, and what were the results?

Have you tried compiling and running in debug mode, following the instructions in our [debugging documentation](https://warpx.readthedocs.io/en/latest/usage/workflows/debugging.html)?
Please specify any relevant compiler flags or environment variables that were used.

## Additional information
If applicable, please add any additional information that may help explain the issue, such as screenshots, diagrams, or other relevant details.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Request a new feature
title: ''
labels: [enhancement]
assignees: ''
---

**What is the context that is prompting you to request a new feature?**
A clear and concise description of the context.

**What feature would you like to add to WarpX?**
A clear and concise description of the feature.

**What alternatives have you considered?**
A clear and concise description of any alternative solutions or features you have considered.

**Additional information**
If applicable, please add other info about the feature request (e.g., links to existing codes, publications, etc.).

**Screenshots**
If applicable, please add screenshots about the feature request.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/installation-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Installation issue
about: Cannot install WarpX? Let us know.
title: ''
labels: [install, question]
assignees: ''
---

**Where are you trying to install WarpX?**
A clear and concise description of where you want to install WarpX.

**Tell us about your software environment**
- operating system: [name and version]
- version of WarpX: [e.g., latest, 24.09, etc.]
- HPC machine: [Are you running on an HPC cluster? We might support it already: https://warpx.readthedocs.io/en/latest/install/hpc.html]

**What have you tried so far?**
- installing WarpX via: [e.g., conda-forge, spack, pip, brew, from source, module system, etc.]

**Are you trying to install from source?**
Please provide:
- the output of `cmake --fresh -S . -B build`
- the output of `cmake --build build`

Let us also know more about your software environment (if applicable):
- version of CMake: [e.g., 3.24.0]
- name and version of C++ compiler: [e.g., GNU 11.3 with NVCC 12.0.76]
- name and version of Python implementation: [e.g., CPython 3.12]
- name and version of MPI: [e.g., OpenMPI 4.1.1]
- version of FFTW: [e.g., 3.3.10]
- version of HDF5: [e.g., 1.14.0]
- version of ADIOS2: [e.g., 2.10.0]
- other relevant dependency names and versions: [e.g., NumPy 2.0, Ascent 0.8.0, etc.]

**Additional information**
If applicable, please add other info to help explain the issue.

**Screenshots**
If applicable, please add screenshots to help explain the issue.
Loading