File: README.md

package info (click to toggle)
python-awkward 2.8.9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 24,932 kB
  • sloc: python: 178,875; cpp: 33,828; sh: 432; makefile: 21; javascript: 8
file content (25 lines) | stat: -rw-r--r-- 917 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# Cython header-only example

This example demonstrates the use of Cython to build Awkward Arrays using `LayoutBuilder`
and return them to a Python caller. The important files are:
1. `demo_impl.cpp` — an example C++ source file that builds an Awkward Array using `LayoutBuilder`.
2. `include/demo_impl.h` — the corresponding header file associated with `demo_impl.cpp`.
3. `_demo.pyx` — a Cython module that interfaces `demo_impl.cpp` with Python.
4. `_demo_impl.pxd` — a Cython declaration file that declares the C++ types of `demo_impl.cpp` to Cython.

The remaining files are associated with Python/CMake configuration, and are not an important part of this example.

## Usage

1. Install the library
    ```bash
    pip install .
    ```
2. Run the demo function and print the returned `ak.Array`
    ```python
    from demo import create_demo_array

    print(
        create_demo_array()
    )
    ```