geant4-python-application 0.1.0__cp38-cp38-macosx_11_0_arm64.whl

geant4_python_application-0.1.0.dist-info/METADATA

@@ -0,0 +1,220 @@
+Metadata-Version: 2.2
+Name: geant4_python_application
+Version: 0.1.0
+Summary: Geant4 Python Application
+Author-Email: Luis Antonio Obis Aparicio <luis.antonio.obis@gmail.com>
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Requires-Dist: awkward
+Requires-Dist: vector
+Requires-Dist: fsspec
+Requires-Dist: pyarrow
+Requires-Dist: awkward-pandas
+Requires-Dist: numpy
+Requires-Dist: requests
+Requires-Dist: platformdirs
+Requires-Dist: tqdm
+Provides-Extra: gui
+Requires-Dist: PyQt5-Qt5<5.16,>=5.15.2; extra == "gui"
+Provides-Extra: dev
+Requires-Dist: boost_histogram; extra == "dev"
+Requires-Dist: hist; extra == "dev"
+Requires-Dist: uproot; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-xdist; extra == "test"
+Requires-Dist: pytest-timeout; extra == "test"
+Requires-Dist: pytest-rerunfailures; extra == "test"
+Description-Content-Type: text/markdown
+
+# Geant4 Python Application
+
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/lobis/geant4-python-application/HEAD?labpath=attenuation.ipynb)
+[![Binder](https://binderhub.ssl-hep.org/badge_logo.svg)](https://binderhub.ssl-hep.org/v2/gh/lobis/geant4-python-application/HEAD?labpath=attenuation.ipynb)
+
+[![Wheels](https://github.com/lobis/geant4-python-application/actions/workflows/wheels.yaml/badge.svg)](https://github.com/lobis/geant4-python-application/actions/workflows/wheels.yaml)
+[![Build and Test](https://github.com/lobis/geant4-python-application/actions/workflows/build-test.yaml/badge.svg)](https://github.com/lobis/geant4-python-application/actions/workflows/test.yaml)
+
+This is an experiment at providing a pythonic interface to Geant4.
+
+The goal is not to provide a full python interface to Geant4, but rather to
+provide a high-level interface to a generic Geant4 application which is highly
+configurable.
+
+If you are looking for a full set of python bindings for Geant4, I recommend
+looking at [geant4_pybind](https://github.com/HaarigerHarald/geant4_pybind).
+
+## Overview
+
+- Configurable Geant4 application written in C++
+- Python interface to the application via
+  [pybind11](https://github.com/pybind/pybind11)
+- The complete event data is available as an
+  [awkward array](https://github.com/scikit-hep/awkward)
+
+New to Geant4 or this package? See the
+[Python developer guide](PYTHON_DEVELOPER_GUIDE.md).
+
+## Platform support
+
+Tested on macOS and Ubuntu; still undergoing broader testing. If you hit a bug,
+please report it via
+[GitHub Issues](https://github.com/lobis/geant4-python-application/issues) or
+reach out to kavyavadhwa@gmail.com.
+
+## Installation
+
+Prebuilt wheels for macOS (Apple Silicon and Intel) and Linux x86_64, Python 3.8
+– 3.13, bundle Geant4 — no separate Geant4 (C++) installation is needed:
+
+```bash
+pip install "geant4-python-application[gui]"
+```
+
+The `gui` extra adds the interactive Qt viewer; leave it out for a physics-only
+install.
+
+Geant4's physics data files download automatically on first use, so you can run
+an example straight away:
+
+```bash
+python examples/geant4-examples/Geant4-11.4.2-examples-python/basic/B1/b1.py --batch -n 10
+```
+
+`--batch` runs headless; drop it to open the Qt viewer.
+
+Building from source (other platforms, development), the Qt viewer, and data
+file management are covered in [INSTALLATION.md](INSTALLATION.md).
+
+## Usage
+
+```python
+import geant4_python_application as g4
+
+# Use a temporary directory for the Geant4 data files (remove this line to use the default location)
+g4.application_directory(temp=True)
+
+with g4.Application(gdml=g4.basic_gdml, seed=137) as app:
+    events = app.run(100)
+
+print(events)
+```
+
+A Geant4 reference physics list can be selected by name:
+
+```python
+with g4.Application(gdml=g4.basic_gdml, physics="FTFP_BERT") as app:
+    events = app.run(100)
+
+print(g4.Application.available_physics_lists())
+```
+
+Particle guns and Geant4's General Particle Source have a Python interface:
+
+```python
+with g4.Application(gdml=g4.basic_gdml) as app:
+    app.generator.use_gps().particle("gamma").energy(2, "MeV")
+    app.generator.position(0, 0, -10, "cm").direction(0, 0, 1)
+    events = app.run(100)
+```
+
+Advanced GPS distributions remain accessible through
+`app.generator.commands(["/gps/pos/type Plane", ...])`.
+
+Optical physics and uniform global magnetic/electric fields can be enabled
+directly:
+
+```python
+with g4.Application(gdml=my_optical_gdml, optical=True) as app:
+    app.detector.magnetic_field = (0.0, 0.0, 1.5)  # tesla
+    app.detector.electric_field = (0.0, 0.0, 0.5)  # kV/cm
+    events = app.run(100)
+```
+
+Optical scintillator GDML + tuning helpers:
+
+```python
+from geant4_python_application import optical as gopt
+
+with g4.Application(gdml=gopt.optical_water_gdml, optical=True) as app:
+    app.commands(gopt.scintillation_commands(yield_factor=1.0))
+    events = app.run(100)  # track.particle contains 'opticalphoton'
+```
+
+Recorded steps can be scored per event or into a Cartesian energy mesh:
+
+```python
+energy_per_event = g4.Scoring.energy_deposit(events, volume="detector")
+mesh, edges = g4.Scoring.energy_mesh(events, bins=(20, 20, 40))
+```
+
+Python run/event/track/step callbacks (offline over awkward arrays):
+
+```python
+with g4.Application(gdml=g4.basic_gdml) as app:
+    events = app.run_with_callbacks(
+        100,
+        on_run=lambda evs: print(len(evs)),
+        on_event=lambda ev: None,
+        on_track=lambda tr, ev: None,
+        on_step=lambda st, tr, ev: None,
+    )
+```
+
+Extra physics constructors incl. DNA, CAD/VTK/ROOT/HepMC, and MPI splitting:
+
+```python
+print(g4.Application.available_extra_physics())
+with g4.Application(gdml=g4.basic_gdml, physics="FTFP_BERT") as app:
+    app.add_physics(
+        "G4EmDNAPhysics_option2"
+    )  # or G4EmExtraPhysics, G4OpticalPhysics...
+    events = app.run(100)
+
+from geant4_python_application import cad, io as gio, distributed as dist
+
+gdml = cad.mesh_to_gdml(*cad.cube_mesh(100.0))  # or cad.stl_ascii_to_gdml(stl_text)
+gio.mesh_to_vtk(mesh, edges, "mesh.vtk")
+gio.events_to_parquet(events, "events.parquet")
+gio.events_to_root(events, "events.root")  # needs uproot
+primaries = gio.hepmc_to_primaries(open("events.hepmc").read())
+
+rank, size = dist.get_rank_size()
+start, count = dist.split_count(1000, rank, size)  # mpiexec -n 2 python run.py
+```
+
+### Interactive Qt visualization
+
+Install with the `gui` extra (`pip install "geant4-python-application[gui]"`),
+or for source builds see [INSTALLATION.md](INSTALLATION.md). Then open Geant4's
+interactive Qt viewer. The call returns when the window is closed, and commands
+can be entered in the viewer's command panel:
+
+```python
+import geant4_python_application as g4
+
+with g4.Application(gdml=g4.basic_gdml, seed=137) as app:
+    app.command("/gun/particle e-")
+    app.command("/gun/energy 100 MeV")
+    app.visualize()
+```

geant4_python_application-0.1.0.dist-info/RECORD

@@ -0,0 +1,66 @@
+geant4_python_application/__init__.py,sha256=Nj-qbn1PWXkpwkO-uzs5lU6UcT60SyCU1BVy8eIC07g,1524
+geant4_python_application/_geant4_application.cpython-38-darwin.so,sha256=vTxwx99V3RgNCf-A0VeeO_WKZuhtLHpQuJ2DqC5nNQk,478976
+geant4_python_application/_geant4_vis.cpython-38-darwin.so,sha256=u_xzBMV0eaaJwWghZTzlKuSNlvEo8Cj2k48sk3uaQ3g,210816
+geant4_python_application/_qt_from_pyqt5_qt5,sha256=sAPo7eUVicGk8vDOx3YgTTPK9bBdN_MhwPm2B3KLOd4,10
+geant4_python_application/_version.py,sha256=KKGREqWbDmaC3uLjgwO5H5klVF7QpaVnqfbMBu8B8WU,528
+geant4_python_application/application.py,sha256=jYjQeBTBdt6kpxV8dYDAecX_X_qG7BA-wSL1qPZnGDw,15996
+geant4_python_application/cad.py,sha256=npswUCOE3ZSXywWsV-7ee-gnpq6EMPtJWxXnb246oGE,3842
+geant4_python_application/detector.py,sha256=HxMdAgnkAxqkPjkn9T4t3F2ugWxQ3uHonP0ACKAB9nQ,3145
+geant4_python_application/distributed.py,sha256=eHoKWsv8Hx85PkdN38poZHN-7o-2jL5RtkwHRor_7AQ,1505
+geant4_python_application/events.py,sha256=9ohHv-jUUEdc82yAZq7d5HOOjGBObfBybkYyOIkmP_M,2982
+geant4_python_application/gdml.py,sha256=_nOtSufrkK5cCLru-KEe3IQ36MtOcqv1mWvca-avzSQ,1173
+geant4_python_application/generator.py,sha256=nr1IFsMNIwJrTWxy4HqMhGcMSH9z5_e8aAIsFU5LqiY,2114
+geant4_python_application/geometry.py,sha256=jXLY0tnokbl5nwQTFEkEBXznNeYOfvvHp_Jbq3SgJtY,1987
+geant4_python_application/io.py,sha256=wLdwuhNkzz7n4RBl7viMrpbbIg-oB_e-W07qy9NCWCI,5155
+geant4_python_application/optical.py,sha256=x8NQPI34Uz32rn5-_8blItJvodn96mn_9thJLL6xHgQ,9281
+geant4_python_application/scoring.py,sha256=lArRXdUg_q5DtEnvP7m7pQlYGkYIM1xu1U2v4mfIT0M,4212
+geant4_python_application/.dylibs/libG4FR.dylib,sha256=DqOWqARLMv6cymMCzMqHqJ9W9XAk-JhoQ71URhsVksQ,169136
+geant4_python_application/.dylibs/libG4GMocren.dylib,sha256=zyMRF0dIcH9F7AJwdxq7JRXZryK1NRjQ89LtPqB5h9w,358896
+geant4_python_application/.dylibs/libG4OpenGL.dylib,sha256=3DwEH0nG6cMofz5rRwxQRPjAs7opaCTlwHamg2B2QRo,611168
+geant4_python_application/.dylibs/libG4RayTracer.dylib,sha256=CBtPoOH9WsD5OquAC_Eqjnpz2-ywmvB0yKPTSdJRNKU,222192
+geant4_python_application/.dylibs/libG4ToolsSG.dylib,sha256=Gq-Y_aSgwddYNPdX1gG3neBOQUQdddnrqck6XLsGPFY,1974464
+geant4_python_application/.dylibs/libG4Tree.dylib,sha256=BNUbkH2hytQ6W8Nuy1LMBZUd8Qssk1WLwCFzqy9eyaY,151760
+geant4_python_application/.dylibs/libG4VRML.dylib,sha256=6ls3RkVqItu5hgqtamAP_3YcFTkqLZjdLtIbOheETsE,149776
+geant4_python_application/.dylibs/libG4analysis.dylib,sha256=Fvb_51Xmz9AZf8lI9EPYcQm2KheWFKTTKZXzWXCtbKM,4353424
+geant4_python_application/.dylibs/libG4clhep.dylib,sha256=vPW0n14Y-Uf-mvP1MiL26Qf8VTV4KshVHUv2I5xTbHc,704912
+geant4_python_application/.dylibs/libG4digits_hits.dylib,sha256=7SQbK65HiFEuIG20uELawjDqYrTsCBahcScAoqEcU9I,638672
+geant4_python_application/.dylibs/libG4error_propagation.dylib,sha256=M3rOhyRQNKHA8t3glmSVTY7CyMLqfFwOzs3W1fF0ssk,252288
+geant4_python_application/.dylibs/libG4event.dylib,sha256=N_Ng5Gne6KvBkbE5gAKPUH9Css4vbspWF8t5sVSQte4,500240
+geant4_python_application/.dylibs/libG4expat.dylib,sha256=yGnnvejWkoI-9FRs10PREzE3FvszXDa9gJsxiU0TwjM,199568
+geant4_python_application/.dylibs/libG4gdml.dylib,sha256=to72muG4Ruaj0tX6raK4KLRM5KXMT3-el22LYnSy1y0,3879008
+geant4_python_application/.dylibs/libG4geometry.dylib,sha256=KS1p91ixnQT_yje2N8yg4oHMVczOK2YIC1Wa_Y7ZnTU,2496096
+geant4_python_application/.dylibs/libG4geomtext.dylib,sha256=dgnsr-8hlqU8Jj5YQDhYKq_662yj0pzuPNM0GVFUeaY,521440
+geant4_python_application/.dylibs/libG4global.dylib,sha256=TjH3o3PiMMrKI1jw9plccsZGzTqSqQwNSiiPTN33P2M,618432
+geant4_python_application/.dylibs/libG4graphics_reps.dylib,sha256=LgdQg_554_yDtuqG-ZgqSiPgEo6hbWYq3EeGhwphoNs,371056
+geant4_python_application/.dylibs/libG4intercoms.dylib,sha256=ZbmB8dGj25DdqoVrp--kKcUF6P4ro5TYzCWAmZ2arM0,379968
+geant4_python_application/.dylibs/libG4interfaces.dylib,sha256=p10J1gYhKY3kiMpwA1t0W_8UUq4cVEPODkZk5I_4wAQ,537120
+geant4_python_application/.dylibs/libG4materials.dylib,sha256=SuXQtjb5MznXEFAVJ8vDsbKGHQ3JvQax4v_JGa6j3BU,851328
+geant4_python_application/.dylibs/libG4mctruth.dylib,sha256=qcWWSbnF7W2Hu-HdOPqT8agf8OWgkdm0NE1Dl4nrrqc,194768
+geant4_python_application/.dylibs/libG4modeling.dylib,sha256=SYowDchYYDuAusjZaGZx3aDB_TkrSYpZktPJhW6Nphg,804416
+geant4_python_application/.dylibs/libG4parmodels.dylib,sha256=Nzlpk_EwCL0LOa_mH2wIUGr7gS17cti_WP5xNKzZB68,237648
+geant4_python_application/.dylibs/libG4particles.dylib,sha256=9uPeaXnlrMNeWsDPvuC-t-yJHFtGNuLfItVgzKKScR0,1049728
+geant4_python_application/.dylibs/libG4physicslists.dylib,sha256=qn5vrJtWRX55cAIdUj5exV1R5A4SyuePsijUkOA76NE,1206928
+geant4_python_application/.dylibs/libG4processes.dylib,sha256=KMM38IEOzQhWKv-5dit5CzCcbsPRoPx2wTCRxL1l1zI,24670128
+geant4_python_application/.dylibs/libG4ptl.2.3.3.dylib,sha256=j-lSTUQejFnIzFpFaB1dz5qDaP4ojeqx1W6TuN99_Pw,230240
+geant4_python_application/.dylibs/libG4readout.dylib,sha256=pTfVzRNrVkF-BkJ86-pSrYgNhBsVYzdfwVnes7UejsU,114576
+geant4_python_application/.dylibs/libG4run.dylib,sha256=Uv-ol0DJF9tvxyMaAS2dMAQmFt_WDMEoG0aCKDxpydA,773600
+geant4_python_application/.dylibs/libG4track.dylib,sha256=N-swYkKPTCPObwCWclFWO31uYl2mjRX_qF6kaPX5Z5A,173104
+geant4_python_application/.dylibs/libG4tracking.dylib,sha256=5PUn_tmm6G7JQlfeIT77UWVayf50BoF7KR1NFPzU1mE,355200
+geant4_python_application/.dylibs/libG4visHepRep.dylib,sha256=neicQLAFcYA5WhDYMH-XWDRQZ7bRkfmTE8AyWsoQTtU,189024
+geant4_python_application/.dylibs/libG4vis_management.dylib,sha256=U05Mkx61Wxuh4DwDmaureHu1GMU6cjkJXlJ5Go8BpN8,1213792
+geant4_python_application/files/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
+geant4_python_application/files/datasets.py,sha256=9gvNK9DOWe-bT1NPqyVZj2-Wwudw_E65iLBmqa-qrqs,9900
+geant4_python_application/files/directories.py,sha256=f7ztXEGkNm3O0w83wj2edfbjV2oenvORXNc3hWi7qx8,1252
+geant4_python_application-0.1.0.dist-info/licenses/LICENSE,sha256=1veepVBCxyrlDtypLU5VdQIa8BVOX_wDc3arkez5W8s,1513
+geant4_python_application-0.1.0.dist-info/licenses/NOTICE,sha256=fl7kzaWfjk9rbjkFah6tJ-Ka4VvJPmuvOdXv1VKfF-0,1081
+geant4_python_application-0.1.0.dist-info/licenses/licenses/CLHEP-COPYING,sha256=jOtLnuWt7d5Hsx6XXB2QxzrSe2sWWh3NgMfFRetluQM,35147
+geant4_python_application-0.1.0.dist-info/licenses/licenses/CLHEP-COPYING.LESSER,sha256=2n6rt7r999OuXp8iOqW9we7ORaxWncIbOwN1ILRGR2g,7651
+geant4_python_application-0.1.0.dist-info/licenses/licenses/Expat-COPYING,sha256=9u6yMQ0LAOXOysOcc6Bpalvb-3VLJjJe1aUC_BpsM4w,1208
+geant4_python_application-0.1.0.dist-info/licenses/licenses/Geant4-LICENSE,sha256=HzJlVIMkxq7Z53FfC_reGtqpHoewtDPmD70uey6gXj4,4030
+geant4_python_application-0.1.0.dist-info/licenses/licenses/PTL-LICENSE,sha256=yK0R0AmSlMuvFVWVNtgJZSIHglOyRjq_Y09hZ4FnoAU,1075
+geant4_python_application-0.1.0.dist-info/licenses/licenses/Xerces-C-LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+geant4_python_application-0.1.0.dist-info/licenses/licenses/Xerces-C-NOTICE,sha256=leXMov89CAGEHZ0X8O7Ba_sC3WiT_35V2k7Fpd0wqlI,560
+geant4_python_application-0.1.0.dist-info/licenses/licenses/zlib-LICENSE,sha256=MbjjDsDsJBWsK--wDpZbQoB7x5NNVcmBqUUVAMFKVaI,1002
+geant4_python_application-0.1.0.dist-info/METADATA,sha256=Hi09PyuJA43RaBaboJaVaOcbZaZdk-5rnTJf4zmaQu4,7787
+geant4_python_application-0.1.0.dist-info/WHEEL,sha256=El_UfoOA3HMQswpRxqDi6xz8Sqkmqjy0_5lyN4UOFQY,111
+geant4_python_application-0.1.0.dist-info/RECORD,,

geant4_python_application-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 1.0.3
+Root-Is-Purelib: false
+Tag: cp38-cp38-macosx_11_0_arm64
+

geant4_python_application-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Luis Antonio Obis Aparicio
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

geant4_python_application-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1,21 @@
+geant4-python-application
+Copyright (c) 2023, Luis Antonio Obis Aparicio and contributors.
+Licensed under the BSD 3-Clause License; see LICENSE.
+
+The prebuilt wheels bundle the following third-party libraries. Their licence
+texts are in the licenses/ directory (installed in the wheel's .dist-info).
+
+- Geant4 11.2.2 (https://geant4.web.cern.ch): Geant4 Software License,
+  licenses/Geant4-LICENSE.
+- CLHEP, as shipped inside Geant4 (G4clhep): GNU LGPL v3,
+  licenses/CLHEP-COPYING.LESSER and licenses/CLHEP-COPYING. It is bundled as a
+  separate shared library that can be replaced.
+- Expat, as shipped inside Geant4 (G4expat): MIT, licenses/Expat-COPYING.
+- PTL, as shipped inside Geant4 (G4ptl): MIT, licenses/PTL-LICENSE.
+- zlib, as shipped inside Geant4 (G4zlib, Linux wheels): zlib License,
+  licenses/zlib-LICENSE.
+- Apache Xerces-C++ 3.2.5 (https://xerces.apache.org): Apache License 2.0,
+  licenses/Xerces-C-LICENSE and licenses/Xerces-C-NOTICE.
+
+Qt is not bundled. The optional [gui] extra installs it from the PyQt5-Qt5
+package, which carries its own licence (LGPL v3).