Metadata-Version: 2.4
Name: gpbeam
Version: 0.0.1
Summary: Python wrapper for the Guinea-Pig code simulating collisions of charged particle beams.
Author-email: Conrad Caliari <conrad.caliari@cern.ch>
License-Expression: GPL-3.0-only
Project-URL: Homepage, https://github.com/cc97nitu/gpbeam
Project-URL: Issues, https://github.com/cc97nitu/gpbeam/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.0
Requires-Dist: scipy>=1.16
Requires-Dist: platformdirs>4.5
Dynamic: license-file

# Guinea-Pig Beam-Beam Simulation

Python wrapper for the [Guinea-Pig](https://gitlab.cern.ch/clic-software/guinea-pig) code simulating collisions of charged particle beams.

## Configuration

Before using this Python wrapper, you need to create a configuration file to specify the path to the Guinea-Pig executable and a working directory for intermediate files.

```
~/.config/guineapig/config.toml
```

Example configuration:
```
# Path to the working directory for intermediate files
WORKDIR = "/dev/shm/"

# Path to the Guinea-Pig executable
EXECUTABLE_GUINEA_PLUSPLUS = "/opt/SimulationCodes/guinea-pig/bin/guinea"
```
