<commit_before>[![Build Status](https://travis-ci.org/ScreamingUdder/isis_nexus_streamer.svg?branch=master)](https://travis-ci.org/ScreamingUdder/isis_nexus_streamer)

# ISIS NeXus Streamer
Stream event data from a NeXus file from RAL/ISIS.
Unit tests use Google Test.

## Dependencies
Currently requires having `librdkafka` and the HDF5 C++ library installed.
`gtest` is not required to be installed, CMake will download and build it at configure-time.

## Running the unit tests
The unit test executable `unitTests` needs to be passed the path of the test data directory as an argument.
Alternatively, run all units tests using ctest with
```
ctest -VV
```
from the build directory.<commit_msg>update readme to inform that git lfs is used<commit_after>[![Build Status](https://travis-ci.org/ScreamingUdder/isis_nexus_streamer.svg?branch=master)](https://travis-ci.org/ScreamingUdder/isis_nexus_streamer)

# ISIS NeXus Streamer
Stream event data from a NeXus file from RAL/ISIS.
Unit tests use Google Test.

## Dependencies
Currently requires having `librdkafka` and the HDF5 C++ library installed.
`gtest` is not required to be installed, CMake will download and build it at configure-time.

The repository contains a NeXus file for testing and therefore requires git lfs to be installed:
https://git-lfs.github.com/

## Running the unit tests
The unit test executable `unitTests` needs to be passed the path of the test data directory as an argument.
Alternatively, run all units tests using ctest with
```
ctest -VV
```
from the build directory.
{'fraction_non_alphanumeric': 0.08134280180761781, 'fraction_numerical': 0.0012911555842479018, 'mean_word_length': 5.078431372549019, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 5, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2417382', 'n_tokens_mistral': 480, 'n_tokens_neox': 457, 'n_words': 188}