awkward-kaitai 0.1.0

Description:

awkwardkaitai 0.1.0

Kaitai Struct: runtime library for Awkward
This library building Awkward Arrays using Kaitai Struct API for Awkward using
C++/STL.
Steps
1. Write a .ksy file for your custom file format. Refer to the Kaitai User Guide for more details.
Here, we take an example of animal.ksy
meta:
id: animal
endian: le
license: CC0-1.0
ks-version: 0.8

seq:
- id: entry
type: animal_entry
repeat: eos

types:
animal_entry:
seq:
- id: str_len
type: u1

- id: species
type: str
size: str_len
encoding: UTF-8

- id: age
type: u1

- id: weight
type: u2

2. Clone kaitai_struct_awkward_runtime repository:
git clone --recursive https://github.com/ManasviGoyal/kaitai_struct_awkward_runtime.git

cd kaitai_struct_awkward_runtime

git checkout ManasviGoyal/test

3. Update submodule and compile scala code (only the first time)
git submodule update --init

cd kaitai_struct_compiler

sbt package

cd ../

4. Generate the source and header files for Awkward target
./kaitai-struct-compiler -t awkward --outdir src-animal example_data/schemas/animal.ksy

5. Install the library
pip install .

6. Build awkward_kaitai by passing the path of the main .cpp from the generated code.
awkward-kaitai-build src-animal/animal.cpp -b build


Note:
awkward-kaitai-build [-h] [-d DEST] [-b BUILD] file
options:

-h, --help: shows help message
-d DEST, --dest DEST: explicitly specify a destination for the build shared library.
-b BUILD, --build BUILD: explicitly specify a build location.


7. Open python and print the returned ak.Array:
python

import awkward_kaitai

animal = awkward_kaitai.Reader("./src-animal/libanimal.so") # pass the path of the shared file
awkward_array = animal.load("example_data/data/animal.raw")

print(awkward_array.to_list())

Output
[{'animalA__Zentry': [{'animal_entryA__Zstr_len': 3, 'animal_entryA__Zspecies': 'cat', 'animal_entryA__Zage': 5, 'animal_entryA__Zweight': 12}, {'animal_entryA__Zstr_len': 3, 'animal_entryA__Zspecies': 'dog', 'animal_entryA__Zage': 3, 'animal_entryA__Zweight': 43}, {'animal_entryA__Zstr_len': 6, 'animal_entryA__Zspecies': 'turtle', 'animal_entryA__Zage': 10, 'animal_entryA__Zweight': 5}]}]