summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSam Scholten2025-10-23 15:28:37 +1000
committerSam Scholten2025-10-23 15:28:37 +1000
commitd7ac57d46e56620ebeb71f27e4d5c1382f66f6c3 (patch)
tree75ffa5d8fc0be5f27c99064ac249a88118c0f072 /README.md
parent307bf648d8e3fe852d7daf2fa1567d1896e50f7e (diff)
downloadtransivent-d7ac57d46e56620ebeb71f27e4d5c1382f66f6c3.tar.gz
transivent-d7ac57d46e56620ebeb71f27e4d5c1382f66f6c3.zip
Add project logo to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index c1e020f..2b52ac5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# transivent
+<img src="logo.svg" width="120" markdown="1">
+
`transivent` is a Python library for detecting and analysing transient events (~spikes) in time-series data. It provides a flexible and configurable pipeline for processing waveform data, identifying events based on signal-to-noise ratio, and visualizing the results. The library is designed to handle large files efficiently through chunked processing.
Additionally, `transivent` includes tools for diffusion analysis of detected events, including Mean Square Displacement (MSD) calculation, autocorrelation analysis, and statistical visualization.