pyg4ometry
Python code for rapid creation and conversion of radiation transport Monte Carlo (Geant4 and Fluka) geometries.
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!
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:
How to Install
Pre-built pyg4ometry wheels can be installed from PyPI using pip:
pip install pyg4ometry
If you cannot find wheels for your operating system / architecture, please open an issue. Building from source requires some non-Python software dependencies. More documentation can be found in the installation guide in the manual.
Many people and groups are using pyg4ometry
- Geometries for BDSIM Geant4 simulation of accelerators
- LEGEND experiment
- FASER2 detector
- CERN North area
- Moller
- 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
and the Zenodo release:
Citation information can be also obtained on GitHub by selecting “Cite this repository” in the sidebar on the right.
1 maintainer
Metadata
1 maintainer
Release files for pyg4ometry 1.4.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyg4ometry-1.4.6.tar.gz | 7.0 MB | Details |
Built distributions (wheels)
Total release size: 400.9 MB
Release files / pyg4ometry-1.4.6.tar.gz
| Download URL | pyg4ometry-1.4.6.tar.gz |
|---|---|
| Size | 7.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
37cd80eda2c3bea3b8dacab324d8215ef9098c1c51d8bffd0a2d1a26d077341e
|
|
BLAKE2b-256 checksum How to use checksums |
87b0dcfc5d08b8150512312e87aca6a4e34bd73f43beabc9d5d38ee80c015a52
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 35.0 MB |
| Tags | CPython 3.14 CPython 3.14 free-threading Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
64542f8f585a61ae8d30d76fbbafb8e57645c869d81b00398c96655a931e9a47
|
|
BLAKE2b-256 checksum How to use checksums |
e1e85141f38ade8ab0d0491550b2026c49823e2c141bb504d10b5008f58d2f72
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp314-cp314-win_amd64.whl
| Download URL | pyg4ometry-1.4.6-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 8.8 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
8c402958a27d275296dc654301c5da2341fe3ca0944b8459844f0d3253770c55
|
|
BLAKE2b-256 checksum How to use checksums |
db76b35f2e8142cee6f2d7191bbc7ca782e03987c8897561635d85c0871c6211
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 34.9 MB |
| Tags | CPython 3.14 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
4ed4b2e41518c77ef656ba9770193bbfc9229d0632e7aa3f7574b111e382efba
|
|
BLAKE2b-256 checksum How to use checksums |
a4493713ee799b80d3726e52fb40a8a240dd616d70c9c02db96cc255427e7f6d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp314-cp314-macosx_15_0_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp314-cp314-macosx_15_0_x86_64.whl |
|---|---|
| Size | 8.6 MB |
| Tags | CPython 3.14 macOS 15.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
4bb6bf3751e3e60c0f452cb444521433a86467d006a5d851f09a380c8f179b48
|
|
BLAKE2b-256 checksum How to use checksums |
5823c87432c4a59f182717dda44205c9c1e87f9cf4ea958ba3ef8a16162a2e06
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp314-cp314-macosx_14_0_arm64.whl
| Download URL | pyg4ometry-1.4.6-cp314-cp314-macosx_14_0_arm64.whl |
|---|---|
| Size | 8.0 MB |
| Tags | CPython 3.14 macOS 14.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
6eead52083a3919f7858523b61354622d0490c4bd360027e87fac5fcca79e0eb
|
|
BLAKE2b-256 checksum How to use checksums |
329f6b48802f40adca7ff447051bb46975c8e24d650594a99e141740299c1c55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp313-cp313-win_amd64.whl
| Download URL | pyg4ometry-1.4.6-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 8.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
bbcd1dbdc9870035c263c63a4e6da07c9d92de1ba60d13f28b19d7bf841d21ce
|
|
BLAKE2b-256 checksum How to use checksums |
6c49de64550f2b2d25fad3b82b4c9fcfa5ea5a523de14903955bbded59bb1232
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 34.9 MB |
| Tags | CPython 3.13 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
3bef502a70c747c8e8fbe496190675106b77bb71e670b0ca785958f42a999c7e
|
|
BLAKE2b-256 checksum How to use checksums |
70e0ed8613ab37d4bf1cc5a40ebcdab80348fed23345785febbca8386dd3a4ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp313-cp313-macosx_15_0_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp313-cp313-macosx_15_0_x86_64.whl |
|---|---|
| Size | 8.6 MB |
| Tags | CPython 3.13 macOS 15.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
7c98ee698d025cffa8c0b426a60fd6c583069cbf67affa3d1b0638a7d35332e1
|
|
BLAKE2b-256 checksum How to use checksums |
4872d26bfc400995f1ee8ff61259bd1f9ef57c3a1b66afae93974cc31852787b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp313-cp313-macosx_14_0_arm64.whl
| Download URL | pyg4ometry-1.4.6-cp313-cp313-macosx_14_0_arm64.whl |
|---|---|
| Size | 7.9 MB |
| Tags | CPython 3.13 macOS 14.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
751b5784c47e3f75f9684f35d5fa17a02d02ccaf82ac1b9319844dce268febf7
|
|
BLAKE2b-256 checksum How to use checksums |
761176f32a1601e8361afabc1729cac0b9a27521b47e85454f57c81f82b459c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp312-cp312-win_amd64.whl
| Download URL | pyg4ometry-1.4.6-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 8.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
3d4dd942f4557923f59e375f43b6b01f2766e765b1c3818e2ca300ce3aff6090
|
|
BLAKE2b-256 checksum How to use checksums |
41accedd7f481ce3b3246f02afc550d653d2ad8d1e2257a8a09f3a966f1c318e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 34.9 MB |
| Tags | CPython 3.12 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
3e8c4c7632314272e6d3677e273fe3ac3a25ae9133186e33ee81ddf1c9ae8483
|
|
BLAKE2b-256 checksum How to use checksums |
c50f6c87f0cf38436bcb3da162f93a3ca451fdc04e409d02534a56f60ba82ead
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp312-cp312-macosx_15_0_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp312-cp312-macosx_15_0_x86_64.whl |
|---|---|
| Size | 8.6 MB |
| Tags | CPython 3.12 macOS 15.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
a1a0bfa708caf86aa024c3b4f0cff6411c71be785da8d5297d66be3d058115df
|
|
BLAKE2b-256 checksum How to use checksums |
10a3c079829ad21c1655f23ef38ca05df112de329cca7c5b457e30fc9ff050cf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp312-cp312-macosx_14_0_arm64.whl
| Download URL | pyg4ometry-1.4.6-cp312-cp312-macosx_14_0_arm64.whl |
|---|---|
| Size | 7.9 MB |
| Tags | CPython 3.12 macOS 14.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
038d11b0315849446e467f72c8a38e9573ee0e5b030629867a75f6cff0c54020
|
|
BLAKE2b-256 checksum How to use checksums |
68a6159f17f8b3f2ad0eabe6a342f008b30909e8a25aa906dd9ab986f3cd2d0f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp311-cp311-win_amd64.whl
| Download URL | pyg4ometry-1.4.6-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 8.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
dcd7fe0946c7a78131bb47acceaf19aac83fe71b5b0442afa35e6ace2e7cd19d
|
|
BLAKE2b-256 checksum How to use checksums |
1f395fcc3f8083b9195058246b6450522c7b6f6bb46527fb160fd22eae69ccf9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 34.9 MB |
| Tags | CPython 3.11 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
22ce4856f6f9f7feaa19378d21353be4c5c62e2c16458a58cb2c2c3e8f66ccad
|
|
BLAKE2b-256 checksum How to use checksums |
b368b898d8039f968f6f99f4f1f3ba3b007d99772bfc5fe24cfc9ed76e7c3953
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp311-cp311-macosx_15_0_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp311-cp311-macosx_15_0_x86_64.whl |
|---|---|
| Size | 8.5 MB |
| Tags | CPython 3.11 macOS 15.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
bbb98e7bd0241f0f334427704cb215ab6b71f9b19e75c6683ed0d22de1fae29d
|
|
BLAKE2b-256 checksum How to use checksums |
86cb3e5bc0ab2ff9d469b7aa10e1fb45ac4c63593bff3792c5a4d9c271627173
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp311-cp311-macosx_14_0_arm64.whl
| Download URL | pyg4ometry-1.4.6-cp311-cp311-macosx_14_0_arm64.whl |
|---|---|
| Size | 7.9 MB |
| Tags | CPython 3.11 macOS 14.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
2d1f39f0cbc74bad43b6493be6effc53a1bce0d97a88cd62b344acbd5138f4df
|
|
BLAKE2b-256 checksum How to use checksums |
e6660dd2b56b1ec73659c9d26a8589d77b007c8f886521251a0cace89fccf05d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp310-cp310-win_amd64.whl
| Download URL | pyg4ometry-1.4.6-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 8.4 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
295a7f358746602a327e78b6659a7eba119802407d9221fe7ef2c1c66ee042f6
|
|
BLAKE2b-256 checksum How to use checksums |
39a5be6510d519dd68b632f5e4e27acd0c209c04ee1a7120778964c89c233ab5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 34.8 MB |
| Tags | CPython 3.10 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
1797afdfec913f1b878621ceb83f5da0e9028197cfb6583569ba3623f7748638
|
|
BLAKE2b-256 checksum How to use checksums |
40b731d0df5da72492b027a86e0f5fe4a4b7f5cb2c11f5d4fb11e9e2416a84ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp310-cp310-macosx_15_0_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp310-cp310-macosx_15_0_x86_64.whl |
|---|---|
| Size | 8.4 MB |
| Tags | CPython 3.10 macOS 15.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
274b6fa0d5510cd770bb8ce46b22d5f188679b2cc6cc2c2cf94f54c7f4ef08ac
|
|
BLAKE2b-256 checksum How to use checksums |
fb2c8ba4dc5538b79757190d08f749badd18c5f8f366a6b2788bde844265821b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp310-cp310-macosx_14_0_arm64.whl
| Download URL | pyg4ometry-1.4.6-cp310-cp310-macosx_14_0_arm64.whl |
|---|---|
| Size | 7.8 MB |
| Tags | CPython 3.10 macOS 14.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
35d69bd9ffd29dcc920423c1f31ab9e2c80778d4619aad3f23de02939ac324dc
|
|
BLAKE2b-256 checksum How to use checksums |
e3798309dc272feab75fa812f68bbbb59f302e41aba0813860c5046279ccaa09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp39-cp39-win_amd64.whl
| Download URL | pyg4ometry-1.4.6-cp39-cp39-win_amd64.whl |
|---|---|
| Size | 8.5 MB |
| Tags | CPython 3.9 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
8f37640e2e60c0106c68f84c8bd127b75567f09918bf8b2f6f39ac2631e47a1e
|
|
BLAKE2b-256 checksum How to use checksums |
6c71f93df30262f3d4639fd20bb6db2d8ab100eac6d0692631c8db7244e8b801
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl |
|---|---|
| Size | 34.8 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 |
|
SHA-256 checksum How to use checksums |
d173b6bd27c2b31afb97eebda21449bc402f29c718ce190fb461c070a0ceab1d
|
|
BLAKE2b-256 checksum How to use checksums |
7a2f18bc24d8e4ec692f9af30e81feb59430c595a28464874bd076dcaf886b85
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp39-cp39-macosx_15_0_x86_64.whl
| Download URL | pyg4ometry-1.4.6-cp39-cp39-macosx_15_0_x86_64.whl |
|---|---|
| Size | 8.4 MB |
| Tags | CPython 3.9 macOS 15.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
517da67b5c9726cd2e01a96c1d2ab25f3afedd0f7e0611921aba06904df646f4
|
|
BLAKE2b-256 checksum How to use checksums |
dcc1849902615b412b5771226845b98a88d95a0c4edb825760434436f1221a15
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / pyg4ometry-1.4.6-cp39-cp39-macosx_14_0_arm64.whl
| Download URL | pyg4ometry-1.4.6-cp39-cp39-macosx_14_0_arm64.whl |
|---|---|
| Size | 7.9 MB |
| Tags | CPython 3.9 macOS 14.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
bdba8774f5d6fab1145e56046b7165cb7311d51cd43b5d849f771c0281e8000a
|
|
BLAKE2b-256 checksum How to use checksums |
bf43f1f516755a7d55013d5beadc538fb98e631f929451426501f4bf7f22f5b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
