From 4c81410798dcb2856e158d98dce204f04074cd4f Mon Sep 17 00:00:00 2001 From: Justus Kuhlmann Date: Fri, 21 Jun 2024 14:14:02 +0000 Subject: [PATCH] add README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..976ae57 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# Pyerrors backlog + +With this tool, we aim at making it easy to backlog correlation functions that can be read with `pyerrors`. +This is done in a reproducible way using `datalad`. +In principle, a dataset is created, that is automatically administered by the backlogger, in which data from differnt projects are held together. +Everything is catalogued by a searchable SQL database, which holds the paths to the respective measurements. +The original projects can be linked to the dataset and the data may be imported using wrapper functions around the read methonds of pyerrors.