Appearance

Reporting Bugs Clearly ​

You may not need to report bugs frequently — especially when working with stable tools or well-tested solvers. However, at Avkalan Labs, many projects involve collaborative research and evolving codebases, where scripts, solvers, or workflows are still under development. In such cases, clear bug reporting becomes extremely useful for fast debugging and maintaining progress across the team.

What to Include ​

Whenever you encounter an issue, make sure your report includes:

  1. Description: What exactly went wrong — describe the issue in one or two sentences.
  2. Steps to Reproduce: List the actions or commands that led to the error.
  3. Expected vs. Actual Result: What you expected to happen and what actually occurred.
  4. Error Message or Logs: Copy the exact error or attach a screenshot.
  5. Context: Mention your setup — system, environment, or script name if relevant.

Example ​

Issue: Simulation crashes during mesh loading.

Steps to Reproduce:

  1. Run main_em_solver.py with antenna_mesh_v3.xdmf
  2. Error appears after defining boundary markers.

Expected: Simulation should start normally.

Actual: Runtime error: “MeshFunction dimension mismatch.”

(Attaching error screenshot and log output)

Summary ​

A clear bug report is specific, structured, and reproducible. By providing all relevant details upfront — what happened, how to reproduce it, and supporting visuals — you make it easier for others to understand and resolve the issue efficiently, ensuring smoother collaboration on evolving research projects.