Files
geant4/environments/g4py/README.md
T
2019-12-06 15:12:28 +01:00

79 lines
1.7 KiB
Markdown

Geant4Py
========
_A set of python modules for using Geant4_
System Requirements
-------------------
### CMake
Building system is migrated to CMake system.
### Python
Python2.x and Python 3.x (experimental)
### Boost
Boost_Python is needed.
### (Optional)
ROOT for histogramming/analysis
### Tested Platforms
* CentOS7 (Python2)
* Ubuntu 18.04 LTS (Python3)
How to Install
--------------
Before building library, *GEANT4_INSTALL* environment variable should be set.
# export GEANT4_INSTALL=<Geant4 install path> (zsh, bash)
# setenv GEANT4_INSTALL <Geant4 install path> (csh)
(G4 install path is the path specified by "CMAKE_INSTALL_PREFIX" when building Geant4)
then
# mkdir build
# cd build
# cmake ..
# make
# make install
By default, g4py is installed in \<g4py\>/lib(64) directory.
Before doing tests with CTest, you have to set environment variables
for Geant4 data.
# make
# make install
# ctest
performs automatic unit/integration tests with CTest.
How to Use:
-----------
Some environment variables are required at run time.
### *PYTHONPATH*
Python module search directories, given by a colon-separated list of directories, like
# export PYTHONPATH=<g4py>/lib64:<g4py>/lib64/examples:<g4py>/lib64/tests (zsh, bash)
# setenv PYTHONPATH <g4py>/lib64:<g4py>/lib64/examples:<g4py>/lib64/tests (csh)
### *LD_LIBRARY_PATH*
You might need define LD_LIBRARY_PATH for Geant4 libraries.
# export LD_LIBRARY_PATH=<Geant4 install path>/lib (zsh, bash)
# setenv LD_LIBRARY_PATH=<Geant4 install path>/lib (csh)
### Getting started
You can import Geant4Py modules in Python just like
>>> import Geant4