How to Report an Issue
We use GitHub Issues to track bugs, feature requests, and questions. Reporting through GitHub keeps reports visible to the community and makes it easy for the development team to respond.
Before opening a new issue, search existing issues to check if your problem has already been reported. This avoids duplicates and may lead you to a solution faster.
What to Include in a Bug Report
A good bug report helps us reproduce and fix the problem quickly. Please include:
-
MAPLE version — run:
python -c "import maple; print(maple.__version__)" -
Python version — run:
python --version - Operating system — e.g., Ubuntu 22.04, CentOS 8, macOS 14.
-
GPU and CUDA version — run:
nvidia-smi - Input file — the
.inpfile (or a minimal reproduction) that triggers the issue. - Full error message — the complete traceback or error output.
- Expected behavior — what you expected to happen.
- Actual behavior — what actually happened.
Bug Report Template
Copy this template, fill in the placeholders, and paste it into your GitHub issue:
Title: <one-line summary of the problem>
Description:
<describe what you were trying to do and what went wrong>
MAPLE version: <e.g., 0.1.3>
Python: <e.g., 3.11.5>
OS: <e.g., Ubuntu 22.04>
GPU / CUDA: <e.g., NVIDIA A100, CUDA 12.1>
Input file:
<paste the full .inp file, or a minimal reproduction>
Error:
<paste the complete traceback or error output>
Expected behavior:
<what you expected to happen>
Actual behavior:
<what actually happened>
For general usage questions, check the tutorials and task reference pages first — many common questions are already answered there.
Feature Requests
We welcome suggestions for new features and improvements. When submitting a feature request, please describe:
- The problem you are trying to solve or the workflow you want to improve.
- Your proposed solution or the behavior you would like to see.
- Any alternatives you have considered.
