Support and problem reports
===========================

Read :doc:`installation`, :doc:`quickstart`, :doc:`capabilities`, and
:doc:`examples` before filing a problem.  Community support is best effort.

Public questions and bugs
-------------------------

Use the `GitHub issue tracker <https://github.com/binggu56/pyqed/issues>`_ and
include:

* PyQED release or full Git commit and dirty-tree state;
* Python, operating system, architecture, and dependency versions;
* the smallest runnable input;
* the full traceback or numerical discrepancy;
* units, model/geometry, basis/grid, backend, and tolerances; and
* the expected result and its analytic or independent reference.

Do not attach credentials, private datasets, or proprietary input files.

Security reports
----------------

Do not disclose a suspected vulnerability in a public issue.  Follow
`SECURITY.md <https://github.com/binggu56/pyqed/blob/main/SECURITY.md>`_ for a
private reporting path.

Scientific scope
----------------

A maintainer can help determine whether code matches a documented convention,
but cannot certify an arbitrary model or replace independent scientific
validation.  Reduce unexpected results to a small case and attach a
:doc:`benchmarks` manifest when the issue concerns accuracy or performance.