<commit_before>waterflow
=========

Calculate the rate of flow of a river by analysing measurements in a cross-section
<commit_msg>Extended readme with details about included code<commit_after>waterflow
=========

Calculate the rate of flow of a river by analysing measurements in a cross-section

Packages
---
The code is divided into the following packages

	net.tobysullivan.waterflow // The important bits. That actual library.
	
	net.tobysullivan.waterflow.example // An example usage with heavy commenting to explain what's going on
	
	net.tobysullivan.waterflow.test // Unit tests that should offer complete code coverage of the library.
{'fraction_non_alphanumeric': 0.07298136645962733, 'fraction_numerical': 0.0, 'mean_word_length': 4.608695652173913, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7331312', 'n_tokens_mistral': 173, 'n_tokens_neox': 157, 'n_words': 76}