From b3feea5bf395fd4825f7c012577a5d31e829f5bc Mon Sep 17 00:00:00 2001
From: cmdoret <cyril.mattheydoret@gmail.com>
Date: Thu, 24 Oct 2024 16:36:08 +0200
Subject: [PATCH] docs: basic readme

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.md b/README.md
index e69de29..8d68eaf 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,43 @@
+# SZcore
+
+## Background
+
+This repository hosts an open seizure detection benchmarking platform.
+The aim is to provide an open source platform for the community to submit their seizure detection algorithms and provide automatic benchmark results on various high quality datasets.
+
+## Usage
+
+Users can submit a containerized algorithm by opening a PR adding a yaml file in the `algorithms` directory. The yaml file should describe their algorithm following our schema (see example (LINK)) and point to a publicly available docker image based on our template (see config/template.Dockerfile).
+
+Once the PR is merged, this image is used to execute the algorithm on github actions, compute performance metrics and update a static website hosted on github pages.
+
+## Data flow
+
+```mermaid
+flowchart LR
+
+    subgraph S3
+    EDF[edf]
+    TSVr[TSV ref]
+    TSVh[TSV s3hyp]
+    end
+
+    subgraph Github Actions CI
+        EDF --> ALG{algo}
+        C[yaml] --> ALG
+        ALG --> TSVg[TSV gha]
+        TSVg --> CIu{CI upload}
+        TSVh --> F{eval}
+        F --> G[json]
+        G --> H{site builder}
+        CIu --> TSVh
+        TSVr --> F
+    end
+    subgraph Github pages
+        H --> I[html]
+    end
+```
+
+## Acknowledgement
+
+This project was developed as part of the [ORD for the Sciences hackathon](https://sdsc-hackathons.ch/) organized by [EPFL Open Science](https://www.epfl.ch/research/open-science/) and [SDSC](http://datascience.ch/) by the team "zinalrothorn", composed of [@EishaMazhar](https://github.com/EishaMazhar), [@danjjl](https://github.com/danjjl), [@esthertsw](https://github.com/esthertsw) and [@cmdoret](https://github.com/cmdoret)