gtsimulation 0.1.2

Software for calculations of particle's propagation through the electromagnetic fields and mediums in space.

GT simulation (GT) is software a package that is created for simulations of propagation of charged particles in electromagnetic fields. GT solves the relativistic equation of motion of a particle using Buneman-Boris scheme. That allows to recover the trajectory of a particle with high precision. Additionally, we take into account the energy losses of particles such as, radiation losses (synchrotron radiation), adiabatic losses (in the heliosphere), and the interactions with the medium. As a result of interaction with the medium secondary particles may be created, that are later simulated in GT.

The code is written in a flexible manner, and easily can be extended by inheriting from the abstract classes of each module. To enhance the speed of calculations numba just-in-time compiler is used to compile the main functions.

Installation

GT requires Python 3.10+. To avoid possible package conflicts, you can optionally create an isolated virtual environment using venv:

$ python -m venv gt_env
$ source gt_env/bin/activate

See the venv official documentation for details.

If you plan to use nuclear interaction modeling or secondary particle generation, install Geant4 and activate its environment variables:

$ source /path/to/geant4/bin/geant4.sh

⚠️ Important Geant4 Note: Due to specific memory allocation requirements, Geant4 must be built with BUILD_TLS_MODEL=global-dynamic option or used in single-threaded mode. See Geant4 Build Configuration for details.

Install the package with:

$ pip install gtsimulation

If you do not want to use Geant4, specify the build option during installation:

$ pip install --config-settings=cmake.define.BUILD_GEANT4_COMPONENTS=OFF gtsimulation

Alternatively, you can install the package from the source repository:

$ git clone --depth 1 https://github.com/agmayorov/GTsimulation.git
$ cd GTsimulation
$ pip install .