Skip to content

Project Group

Principal Investigator: Giovanni Castellazzi
Affiliations: Associate Professor in Solids and Structural Mechanics, DICAM — University of Bologna
Email: giovanni.castellazzi@unibo.it

Collaborators Affiliations
Giovanni Castellazzi Solids and Structural Mechanics, DICAM — University of Bologna
Stefano de Miranda Solids and Structural Mechanics, DICAM — University of Bologna
Antonio Maria D'Altri Solids and Structural Mechanics, DICAM — University of Bologna
Francesco Ubertini Solids and Structural Mechanics, DICAM — University of Bologna
Nicolò Lo Presti PhD Student, DICAM — University of Bologna
Kaj Kolodziej Master Student, University of Bologna
Former Collaborators
Gabriele Bitelli Geomatics, DICAM — University of Bologna
Alessandro Lambertini Geomatics, DICAM — University of Bologna

Report a Problem / Bug

Preferred channel: GitHub Issues (recommended for tracking & transparency)
Alternative: Email support (for private data or access‑restricted material)

1) Via GitHub Issues

The preferred way to report issues is via GitHub Issues, as it ensures transparency and allows for better tracking and collaboration. Follow the steps below:

  1. Navigate to the repository’s Issues page.
  2. Click New issue and select Bug report.
  3. Fill out the template, providing as much detail as possible (refer to the checklist below).
  4. Attach relevant files, such as screenshots, logs, or minimal datasets. If your data is sensitive, consider using the email option instead.

By using GitHub Issues, you help streamline the process and contribute to improving the project for everyone.

If your dataset is confidential, please do not upload it publicly. Instead, strip/obfuscate sensitive parts or use the email channel.

2) Via Email

In the case of private or urgent communications send an email to giovanni.castellazzi@unibo.it with subject:
[C2F4DT] Bug report: <short description>

Include the same checklist information below. You may attach files or share a secure link (e.g., institutional cloud drive).

Bug Report Checklist

Please provide the following to help us reproduce and fix the issue quickly:

  1. Summary
  2. Short, descriptive title.

  3. What did you expect to happen? What happened instead?

  4. Steps to Reproduce

  5. Step-by-step instructions.

  6. Minimal files (e.g., a small VTK demonstrating the issue).

  7. Screenshots / Videos

  8. UI state, error dialogs, wrong rendering outcomes, etc.

  9. Logs & Console Output

  10. Copy any text from the built-in Console or terminal.

  11. If available, attach _vtk_report/report.json or similar validator outputs.

  12. Environment

  13. OS (Windows/macOS/Linux + version), Python version.
  14. Package versions: pyvista, vtk, numpy, matplotlib, scipy.

  15. GPU/driver info if rendering‑related.

  16. Configuration

  17. Representation settings (Surface/Wireframe/etc.).
  18. Color by (Solid/PointData/CellData + vector component).
  19. LUT + invert, scalar bar on/off, edges visibility, opacity.

  20. Any custom plugins or local modifications.

  21. Frequency / Regression

  22. Does it happen always or intermittently?
  23. Did it appear after an update? Which version worked?

Example (Minimal) Issue Template

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
**Summary**
Surface with Edges hides nodes when edges are enabled.

**Steps to Reproduce**
1. File ▸ Import VTK… → load `demo.vtu`
2. Representation = Surface with Edges
3. Color by = PointData/displacement (Magnitude)
4. Toggle Edges = ON

**Observed**
Edges are visible but nodes are white.

**Expected**
Edges and scalar-colored nodes visible together.

**Environment**
- OS: Windows 11, Python 3.11
- pyvista 0.43.10, vtk 9.3.0, numpy 2.0.2, matplotlib 3.9.2, scipy 1.13
- GPU: NVIDIA RTX 3070 (driver 552.xx)

**Attachments**
- `_vtk_report/rep_Surface_with_Edges.png`
- Console log excerpt

Optional: GitHub Issue Templates

To streamline reports, consider adding .github/ISSUE_TEMPLATE/ files to your repo:

  • .github/ISSUE_TEMPLATE/bug_report.md
  • .github/ISSUE_TEMPLATE/feature_request.md

Example bug_report.md:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
name: Bug report
description: Create a report to help us improve
labels: [bug]
body:
  - type: textarea
    id: summary
    attributes:
      label: Summary
      description: What happened and what did you expect?
      placeholder: Short description...
    validations:
      required: true

  - type: textarea
    id: repro
    attributes:
      label: Steps to Reproduce
      description: Provide a minimal, complete, and verifiable example.
      placeholder: |
        1. Import file ...
        2. Set representation to ...
        3. Toggle edges ...
    validations:
      required: true

  - type: textarea
    id: evidence
    attributes:
      label: Evidence
      description: Screenshots, logs, minimal datasets, validator output.
    validations:
      required: false

  - type: input
    id: env-os
    attributes:
      label: OS
      placeholder: Windows 11 / macOS 14 / Ubuntu 22.04
    validations:
      required: true

  - type: input
    id: env-python
    attributes:
      label: Python
      placeholder: 3.11.x
    validations:
      required: true

  - type: textarea
    id: env-packages
    attributes:
      label: Package Versions
      placeholder: pyvista, vtk, numpy, matplotlib, scipy
    validations:
      required: true

FAQ

Q: I found a bug while using a confidential dataset. How should I proceed?
A: Prefer the email channel. Provide a minimal, anonymized extract if possible, or share access privately.

Q: Where do I ask for new features or improvements?
A: Use GitHub Issues → Feature request to track discussion and prioritization.

Q: I’m offline and cannot reach GitHub.
A: Send an email to giovanni.castellazzi@unibo.it with the Bug Report Checklist filled in.

Thank you for helping improve C2F4DT! Your clear reports save everyone time and make the tool better for the community.