| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 1 | RMR Python Bindings |
| 2 | =================== |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 3 | |
| 4 | Overview |
| 5 | -------- |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 6 | |
| Lott, Christopher (cl778h) | f55e4d8 | 2020-04-10 16:02:11 -0400 | [diff] [blame] | 7 | The xapp python framework package includes a python subpackage called |
| 8 | `rmr`. This subpackage (`ricxappframe.rmr`) is a CTYPES wrapper |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 9 | around the RMR shared library. Most Xapp users will never use this |
| Lott, Christopher (cl778h) | f55e4d8 | 2020-04-10 16:02:11 -0400 | [diff] [blame] | 10 | subpackage natively; however python apps that need access to the |
| 11 | low-level RMR API can use it. |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 12 | |
| Lott, Christopher (cl778h) | f55e4d8 | 2020-04-10 16:02:11 -0400 | [diff] [blame] | 13 | Usage of this python package requires that the RMR shared-object |
| 14 | library is installed in a system library that is included in the |
| 15 | directories found by default, usually something like /usr/local/lib. |
| 16 | |
| 17 | The RMR library man pages are available here: :doc:`RMR Man Pages <ric-plt-lib-rmr:index>` |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 18 | |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 19 | RMR API |
| 20 | ------- |
| Tommy Carpenter | fbb5928 | 2020-04-08 07:04:51 -0400 | [diff] [blame] | 21 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 22 | .. automodule:: ricxappframe.rmr.rmr |
| 23 | :members: |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 24 | |
| 25 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 26 | RMR Helper API |
| 27 | -------------- |
| Lott, Christopher (cl778h) | 2e1c18a | 2020-04-08 12:41:07 -0400 | [diff] [blame] | 28 | |
| Lott, Christopher (cl778h) | db26ba2 | 2020-04-09 18:25:19 -0400 | [diff] [blame] | 29 | .. automodule:: ricxappframe.rmr.helpers |
| 30 | :members: |