https://github.com/g4edge/pyg4ometry
Python code for rapid creation and conversion of radiation transport Monte Carlo (Geant4 and Fluka) geometries
https://github.com/g4edge/pyg4ometry
cad fluka gdml geant4
Last synced: 4 months ago
JSON representation
Python code for rapid creation and conversion of radiation transport Monte Carlo (Geant4 and Fluka) geometries
- Host: GitHub
- URL: https://github.com/g4edge/pyg4ometry
- Owner: g4edge
- License: gpl-3.0
- Created: 2022-08-09T19:58:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-02-14T23:04:14.000Z (4 months ago)
- Last Synced: 2026-02-15T05:19:21.054Z (4 months ago)
- Topics: cad, fluka, gdml, geant4
- Language: Python
- Homepage: https://pyg4ometry.readthedocs.io
- Size: 21.1 MB
- Stars: 42
- Watchers: 4
- Forks: 20
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# pyg4ometry
Python code for rapid creation and conversion of radiation transport Monte
Carlo (Geant4 and Fluka) geometries.
[](https://pypi.org/project/pyg4ometry/)
[](https://github.com/g4edge/pyg4ometry/actions)
[](https://github.com/pre-commit/pre-commit)
[](https://github.com/psf/black)
[](https://app.codecov.io/gh/g4edge/pyg4ometry)
[](https://doi.org/10.5281/zenodo.10449301)
[](https://pyg4ometry.readthedocs.io)
## Quick start
_pyg4ometry_ is a very capable package to do many tasks related
to Geant4/Fluka/MCNP geometry:
- Python scripting to create and assemble geometries
- Loading, editing and writing GDML
- Load and tessellate CAD geometry and export to GDML
- Load ROOT geometry and convert to GDML
- Powerful VTK viewer of geometries
- Converting from GDML to FLUKA and MCNP
- Exporting mesh geometries from GDML to VTP, OBJ, VRML etc.
- Python bindings to CGAL allowing complex mesh manipulation (e.g. hole filling, remeshing)
All with few lines of Python code!
```py
import pyg4ometry as pg4
from g4edgetestdata import G4EdgeTestData
g4data = G4EdgeTestData()
# define a geometry registry
reg = pg4.geant4.Registry()
# build the world volume
world_s = pg4.geant4.solid.Orb("WorldAir", 1.5, reg, lunit="cm")
world_l = pg4.geant4.LogicalVolume(world_s, "G4_AIR", "WorldAir", reg)
reg.setWorld(world_l)
# import an STL file
reader = pg4.stl.Reader(g4data["stl/utah_teapot.stl"], registry=reg)
teapot_s = reader.getSolid()
# place the teapot in the world
teapot_l = pg4.geant4.LogicalVolume(teapot_s, "G4_Cu", "UtahTeapot", reg)
pg4.geant4.PhysicalVolume([0, 0, 0], [0, 0, 0], teapot_l, "UtahTeapot", world_l, reg)
# export to GDML file "geometry.gdml"
writer = pg4.gdml.Writer()
writer.addDetector(reg)
writer.write("./geometry.gdml")
# start an interactive VTK viewer instance
viewer = pg4.visualisation.VtkViewer()
viewer.addLogicalVolume(reg.getWorldVolume())
viewer.view()
```
Check out our video tutorial for more:
[](https://www.youtube.com/watch?v=OPvQFZsFvhs)
## How to Install
Pre-built _pyg4ometry_ wheels can be installed [from PyPI](https://pypi.org/project/pyg4ometry)
using pip:
```
pip install pyg4ometry
```
If you cannot find wheels for your operating system / architecture,
please [open an issue](https://github.com/g4edge/pyg4ometry/issues).
Building from source requires some non-Python software dependencies.
More documentation can be found in the
[installation guide](https://pyg4ometry.readthedocs.io/en/stable/manual/installation.html) in the manual.
## Many people and groups are using _pyg4ometry_
- Geometries for BDSIM Geant4 simulation of accelerators
- [LEGEND experiment](https://indico.cern.ch/event/1252095/contributions/5592424/attachments/2730430/4746429/202310-PyHEP.pdf)
- [FASER2 detector](https://cds.cern.ch/record/2893550)
- CERN North area
- [Moller](https://www.lucbarrett.info/Poster.pdf)
- Proton therapy beam lines
## Referencing and Citation
To support the development and maintenance of _pyg4ometry_, please cite it!
Any publications including simulations made using this software must cite
the _pyg4ometry_ paper:
> S.D. Walker, A. Abramov, L.J. Nevay, W. Shields, S.T. Boogert,
> “pyg4ometry: A Python library for the creation of Monte Carlo radiation transport physical geometries”,
> Computer Physics Communications 272 108228 (2022). DOI: [10.1016/j.cpc.2021.108228](https://doi.org/10.1016/j.cpc.2021.108228)
and the Zenodo release: [](https://doi.org/10.5281/zenodo.10449301)
Citation information can be also obtained on GitHub by selecting “Cite this repository” in the sidebar on the right.