Metadata-Version: 2.4
Name: swgo-bali
Version: 0.3.0
Summary: Python bindings for the SWGO Background Library
Author-Email: Johannes Bennemann <johannes.bennemann@mpi-hd.mpg.de>
Maintainer-Email: Johannes Bennemann <johannes.bennemann@mpi-hd.mpg.de>
License-Expression: MPL-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3 :: Only
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: Programming Language :: Python :: 3.13
Classifier: Programming Language :: C++
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Operating System :: POSIX :: Linux
Project-URL: Homepage, https://gitlab.com/swgo-collaboration/swgo-background-library
Project-URL: Documentation, https://swgo-background-library-6e5922.gitlab.io/
Requires-Python: >=3.9
Requires-Dist: typing_extensions
Description-Content-Type: text/markdown

# Python Bindings for the SWGO Background Library

This are the Python bindings for the SWGO Background Library.
The bindings can be installed with pip:
```
pip install swgo-bali
```
To access the the Background interface, import `libbackground` and create an instance:
```python
import libbackground as libbg

bg = libbg.Background("<path to settings>")
```
The documentation can be accessed with `help(libbg.Background)`.

The photo electron lists generated by `Background.next_chunk()` are C++ objects, but behave like nested python lists:
```python
for channel_id, pe_times in bg.next_chunk(1e-9):
    # channel_id = int
    for time in pe_times:
        # time = float
        ...
```
The full documentation of the SWGO Background Library can be found [here](https://swgo-background-library-6e5922.gitlab.io/).
