Skip to content

Commit d79bda0

Browse files
committed
[docs] Add python bindings section
1 parent f88391b commit d79bda0

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ More details and examples on the API can be found in the doxygen docs in the hea
260260

261261
### Using ALF as a library
262262

263-
To use ALF as a library the "Alf/Alf.h" convenience header may be used, as seen in [this](src/example.cxx) example. To build, it is necessary to load the alisw environment (`aliswmod enter ALF`) and run the following g++ command. Make sure to adjust the versions according to `aliswmod list` output, when the environment is loaded.
263+
To use ALF as a library the "Alf/Alf.h" convenience header may be used, as seen in [this](src/example.cxx) example. To build, it is necessary to load the ALF environment (`module load ALF`) and run the following g++ command. Make sure to adjust the versions according to `module list` output, when the environment is loaded.
264264

265265
```
266266
g++ -Wall \
@@ -282,3 +282,14 @@ g++ -Wall \
282282
-L /opt/alisw/el7/ReadoutCard/v0.21.3-1/lib \
283283
alf-lib-example.cxx -o ale
284284
```
285+
286+
### Python bindings
287+
The ALF library also offers a python interface through the use of `Boost.Python`. To use it the ALF environment needs to be loaded and the `libO2Alf` library imported.
288+
289+
To read the documentation for the python bindings:
290+
```
291+
module load ALF
292+
python -c "import libO2Alf; help(libO2Alf)"
293+
```
294+
295+
Non-exhaustive examples on usage may be found in the [test](test) directory.

0 commit comments

Comments
 (0)