tsdf 0.6.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
tsdf/tsdfmetadata.py CHANGED
@@ -131,3 +131,13 @@ class TSDFMetadata:
131
131
  :return: datetime object containing the end date.
132
132
  """
133
133
  return parser.parse(self.end_iso8601)
134
+
135
+ start = property(get_start_datetime, set_start_datetime, doc=
136
+ """
137
+ Start time of the recording.
138
+ """)
139
+
140
+ end = property(get_end_datetime, set_end_datetime, doc=
141
+ """
142
+ End time of the recording.
143
+ """)
@@ -1,17 +1,16 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: tsdf
3
- Version: 0.6.0
3
+ Version: 0.6.1
4
4
  Summary: A Python library that provides methods for encoding and decoding TSDF (Time Series Data Format) data, which allows you to easily create, manipulate and serialize TSDF files in your Python code.
5
- Home-page: https://github.com/biomarkersParkinson/tsdf
6
5
  License: Apache-2.0
6
+ License-File: LICENSE
7
7
  Keywords: Time Series Data Format (TSDF),binary data,digital sensors
8
- Author: Peter Kok
9
- Author-email: p.kok@esciencecenter.nl
10
- Requires-Python: >=3.10,<4.0
8
+ Author: Vedran Kasalica
9
+ Author-email: v.kaslica@esciencecenter.nl
10
+ Requires-Python: >=3.11,<3.13
11
11
  Classifier: License :: OSI Approved :: Apache Software License
12
12
  Classifier: Programming Language :: Python
13
13
  Classifier: Programming Language :: Python :: 3
14
- Classifier: Programming Language :: Python :: 3.10
15
14
  Classifier: Programming Language :: Python :: 3.11
16
15
  Classifier: Programming Language :: Python :: 3.12
17
16
  Requires-Dist: numpy (>=1.24.1,<2.0.0)
@@ -25,7 +24,7 @@ Description-Content-Type: text/markdown
25
24
  | Badges | |
26
25
  |:----:|----|
27
26
  | **Packages and Releases** | [![Latest release](https://img.shields.io/github/release/biomarkersparkinson/tsdf.svg)](https://github.com/biomarkersparkinson/tsdf/releases/latest) [![PyPI](https://img.shields.io/pypi/v/tsdf.svg)](https://pypi.python.org/pypi/tsdf/) [![Static Badge](https://img.shields.io/badge/RSD-tsdf-lib)](https://research-software-directory.org/software/tsdf) |
28
- | **Build Status** | [![](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/) ![Python package](https://github.com/biomarkersparkinson/tsdf/workflows/Python%20package/badge.svg) [![pytype Type Check](https://github.com/biomarkersParkinson/tsdf/actions/workflows/pytype-checking.yml/badge.svg)](https://github.com/biomarkersParkinson/tsdf/actions/workflows/pytype-checking.yml) |
27
+ | **Build Status** | [![](https://img.shields.io/badge/python-3.11%2C3.12-blue.svg)](https://www.python.org/downloads/) ![Build and test](https://github.com/biomarkersparkinson/tsdf/workflows/build-and-test.yml/badge.svg) |
29
28
  | **DOI** | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7867899.svg)](https://doi.org/10.5281/zenodo.7867899) |
30
29
  | **License** | [![GitHub license](https://img.shields.io/github/license/biomarkersParkinson/tsdf)](https://github.com/biomarkersparkinson/tsdf/blob/main/LICENSE) |
31
30
  | **Fairness** | [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/8083/badge)](https://www.bestpractices.dev/projects/8083) |
@@ -34,11 +33,16 @@ Description-Content-Type: text/markdown
34
33
 
35
34
  A package ([documentation](https://biomarkersparkinson.github.io/tsdf/)) to load TSDF data ([specification](https://arxiv.org/abs/2211.11294)) into Python.
36
35
 
36
+ ## Overview
37
+ The [tsdf package](10.5281/zenodo.7867899) is a comprehensively documented reference implementation of the Time Series Data Format (TSDF) standard [[1]](https://arxiv.org/abs/2211.11294). TSDF simplifies data storage and exchange of multi-channel digital sensor data, thereby promoting interpretability and reproducibility of scientific results. Sensor measurements and timestamps are stored as raw tabular binary array files. To ensure unambiguous reconstruction, binary array files are accompanied by human-readable JavaScript Object Notation (JSON) metadata files, which contain a set of mandatory fields limited to essential sensor measurement information.
38
+
39
+ The tsdf Python package implements functions for reading and writing TSDF files. It guarantees formatting and metadata consistency. It enforces usage of the essential metadata such as study identification, time frame, data channel descriptions and data attributes corresponding to the binary data.
40
+
37
41
  ## Installation
38
42
 
39
43
  ### Using `pip`
40
44
 
41
- The package is available in PyPi and requires [Python 3.10](https://www.python.org/downloads/) or higher. It can be installed using:
45
+ The package is available in PyPi and requires [Python 3.11](https://www.python.org/downloads/) or higher. It can be installed using:
42
46
 
43
47
  ```bash
44
48
  $ pip install tsdf
@@ -6,12 +6,12 @@ tsdf/numpy_utils.py,sha256=ma87nmF9eYu0oRVqvtWC2uTvShuvkBokQmVlOCbwhoQ,2421
6
6
  tsdf/parse_metadata.py,sha256=OtzCKWaM7Mg0GdS3H0V6i1Cj4liQ-mEG6OcfaqKJOy4,9859
7
7
  tsdf/read_binary.py,sha256=G-EyiioIP_JxjYduJUujLbKBlfaV8eydRNd4hrBTGVw,4113
8
8
  tsdf/read_tsdf.py,sha256=vhAT7vO_NVEmQUg1rij3eUk5fBWOn5tva1d9MtGpxKc,3103
9
- tsdf/tsdfmetadata.py,sha256=EBq-Z8f3Eu92R0i174xNo9KfTsPm2m_VbbXD-7S42fk,4831
9
+ tsdf/tsdfmetadata.py,sha256=x1LDWkej9sLaW1xbkJZpDCrLYvdnD4CXNcmt6iBvWdQ,5081
10
10
  tsdf/validator.py,sha256=8PFB0PHqKKHtDpddyGIIKeqVqvDqcip7Bk7bY_wYzsw,1579
11
11
  tsdf/write_binary.py,sha256=G5QiUXdpYgCZbS4pKhg8tFcqZU7FyaZGTzcNmZwXaPw,2425
12
12
  tsdf/write_tsdf.py,sha256=Ivudc5g1l56R4LX9KfRtRXE1O8KY7uLb3U3XvzYDzM8,6090
13
- tsdf-0.6.0.dist-info/LICENSE,sha256=ps-dSIu_bKnNIZ3_A9i8DjNNcN21Dg81znC5pTQKg3M,9748
14
- tsdf-0.6.0.dist-info/METADATA,sha256=uBwU21vrGsnLiA7Hu3HXowqF5qMxlZHixF1_8uaHZ8o,4114
15
- tsdf-0.6.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
16
- tsdf-0.6.0.dist-info/entry_points.txt,sha256=Bsc8N48btp0lRWhtEwmOOmzZuvdlYDfVSkHFrHK2EXQ,53
17
- tsdf-0.6.0.dist-info/RECORD,,
13
+ tsdf-0.6.1.dist-info/METADATA,sha256=iHn6tE0cXnaUJLvkDyl2KB2ndv69PCPSKuK2UmuaSp8,4823
14
+ tsdf-0.6.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
15
+ tsdf-0.6.1.dist-info/entry_points.txt,sha256=Bsc8N48btp0lRWhtEwmOOmzZuvdlYDfVSkHFrHK2EXQ,53
16
+ tsdf-0.6.1.dist-info/licenses/LICENSE,sha256=ps-dSIu_bKnNIZ3_A9i8DjNNcN21Dg81znC5pTQKg3M,9748
17
+ tsdf-0.6.1.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: poetry-core 1.9.0
2
+ Generator: poetry-core 2.2.1
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any