Merge branch 'main' into package_release

.gitignore

@@ -145,4 +145,5 @@ dmypy.json
 .vscode/
 
 #Binary outputs
-*output.bin
+tests/data/tmp_test*
+

docs/contact.md

@@ -0,0 +1,8 @@
+# Contact
+
+This package has been written by engineers from the [Netherlands eScience Center](https://esciencecenter.nl).
+It is maintained by:
+
+- Peter Kok ([p.kok@esciencecenter.nl](mailto:p.kok@esciencecenter.nl)).
+- Vedran Kasalica ([v.kasalica@esciencecenter.nl](mailto:v.kasalica@esciencecenter.nl)).
+- Pablo Rodríguez-Sánchez ([p.rodriguez-sanchez@esciencecenter.nl](mailto:p.rodriguez-sanchez@esciencecenter.nl)).

docs/index.md

@@ -1,14 +1,10 @@
 # Welcome to tsdf
 
-Apackage to load [TSDF data](https://arxiv.org/abs/2211.11294) into Python.
+A package to load [TSDF data](https://arxiv.org/abs/2211.11294) into Python.
 
 ## What is `TSDF data`?
 
 `tsdf` stands for _time series data format_.
 It is a unified, standardized format for storing all types of physiological sensor data.
 
-More information available in our [preprint](https://arxiv.org/abs/2211.11294).
-
-## Installation
-
-Download or clone the content of [our repository](https://github.com/biomarkersParkinson/tsdf) and install using `poetry` or `pip`.
+More information available in this [preprint](https://arxiv.org/abs/2211.11294).

docs/installation.md

@@ -0,0 +1,36 @@
+# Installation
+
+## Requirements
+
+`tsdf` requires a recent version of [Python](https://www.python.org/) and a Python package manager (such as `pip`).
+Chances are that you have them already installed.
+You can check if that's the case from the command line:
+
+```bash
+python --version
+```
+
+```bash
+pip --version
+```
+
+## Installing tsdf
+
+At the moment tsdf is not part of [PyPI](https://pypi.org/), but the source code is stored and maintained on [GitHub](https://github.com/biomarkersParkinson/tsdf).
+
+If you have `git` installed, the latest version of tsdf can be installed by typing:
+
+```bash
+pip install 'tsdf @ git+https://github.com/biomarkersParkinson/tsdf.git'
+```
+
+Otherwise you can install it manually by following these steps:
+
+1. Download or clone the content from [our repository](https://github.com/biomarkersParkinson/tsdf).
+2. Browse to the folder you just downloaded (typically: `cd tsdf/`).
+3. Install using your package manager (typically: `pip install .`).
+
+## What now?
+
+Now you can import functions from the `tsdf` Python package.
+See some examples in the next section.

docs/usage.ipynb

@@ -0,0 +1,60 @@
+{
+ "cells": [
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Usage \n",
+    "\n",
+    "Input/Output of `tsdf` files (work in progress)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Using `json`"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from tsdf.io import load, loads\n",
+    "\n",
+    "with open(\"../tests/data/flat.json\", \"r\") as read_file:\n",
+    "    data = load(read_file)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.10.8 ('tsdf')",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.16"
+  },
+  "orig_nbformat": 4,
+  "vscode": {
+   "interpreter": {
+    "hash": "237a52c53308e1ad95829edf2d78ec7874ed6722f9691e1e5c1903f01554073b"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}