# pyunisens
Implementation of the Unisens data storage format
## Installation
Stable version can be installed via `pip install pyunisens`
or most recent version via `pip install git+https://github.com/Unisens/pyunisens`
`pyunisens` is running on Python 3.6+
## Quickstart
You can load any unisens object simply like this
```Python
import unisens
u = unisens.Unisens('c:/folder/dataset/') # folder containing the unisens.xml
```
Entries are saved under `.entries` can be accessed either via attributes or using the unisens object as a dictionary
```Python
print(u.entries)
# four ways to Rome
signal = u.signal_bin
signal = u['signal.bin']
signal = u.entries['signal.bin']
signal = u[0]
# shortcuts also work, if they are not ambiguous
signal = u.signal
signal = u['signal']
print(type(signal))
# signalEntry
```
Data can be loaded (if datatypeis supported, ie a standard numpy dtype) via `data= signal.get_data()`
You can add Entries simply by
```Python
import numpy as np
from unisens import SignalEntry
data = np.random(2, 2560)
s = SignalEntry(id='eeg.bin', parent=u)
# parent=u makes sure the signal is added to this Unisens object
# saving the data to eeg.bin
s.set_data(data, sampleRate=256, contentClass='EEG')
u.save() # will update the unisens.xml
```
## Documentation
More documentation can be found at
[API-OVERVIEW.md](API-OVERVIEW.md) and in the function descriptors
## Bug reports / feedback
Please report any bugs or improvements via a Github issue.
Raw data
{
"_id": null,
"home_page": "http://github.com/Unisens/pyUnisens",
"name": "pyunisens",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "skjerns",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/a4/61/7f1ea6d790a89a5c44dec7448e350641bd1cb56e3e34d11fe0843247765b/pyunisens-1.5.0.tar.gz",
"platform": null,
"description": "\n\n\n# pyunisens\nImplementation of the Unisens data storage format\n\n## Installation\nStable version can be installed via `pip install pyunisens`\n\nor most recent version via `pip install git+https://github.com/Unisens/pyunisens`\n\n`pyunisens` is running on Python 3.6+\n\n## Quickstart\n\nYou can load any unisens object simply like this\n\n```Python\nimport unisens\n\nu = unisens.Unisens('c:/folder/dataset/') # folder containing the unisens.xml\n```\n\nEntries are saved under `.entries` can be accessed either via attributes or using the unisens object as a dictionary\n\n```Python\nprint(u.entries)\n\n# four ways to Rome\nsignal = u.signal_bin\nsignal = u['signal.bin']\nsignal = u.entries['signal.bin']\nsignal = u[0]\n\n# shortcuts also work, if they are not ambiguous\nsignal = u.signal\nsignal = u['signal']\n\nprint(type(signal))\n# signalEntry\n```\n\nData can be loaded (if datatypeis supported, ie a standard numpy dtype) via `data= signal.get_data()`\n\nYou can add Entries simply by\n\n```Python\nimport numpy as np\nfrom unisens import SignalEntry\n\ndata = np.random(2, 2560)\ns = SignalEntry(id='eeg.bin', parent=u)\n# parent=u makes sure the signal is added to this Unisens object\n# saving the data to eeg.bin\ns.set_data(data, sampleRate=256, contentClass='EEG')\n\nu.save() # will update the unisens.xml\n```\n\n## Documentation\nMore documentation can be found at \n[API-OVERVIEW.md](API-OVERVIEW.md) and in the function descriptors\n\n\n## Bug reports / feedback\nPlease report any bugs or improvements via a Github issue.\n\n\n",
"bugtrack_url": null,
"license": "GNU 2.0",
"summary": "A python implementation of the Unisens standard",
"version": "1.5.0",
"project_urls": {
"Homepage": "http://github.com/Unisens/pyUnisens"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "65b24a9a75a2c7f41b74cf151574485a25795cc826ea3ca347da80fafd1b5c3e",
"md5": "4723f198e4740a85fd78f893d8733a23",
"sha256": "be6f4ba8b53be9744221580c7badee40401c87398a7052bd3f3f5efb00e339f6"
},
"downloads": -1,
"filename": "pyunisens-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4723f198e4740a85fd78f893d8733a23",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 18164,
"upload_time": "2023-10-30T16:17:19",
"upload_time_iso_8601": "2023-10-30T16:17:19.730149Z",
"url": "https://files.pythonhosted.org/packages/65/b2/4a9a75a2c7f41b74cf151574485a25795cc826ea3ca347da80fafd1b5c3e/pyunisens-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a4617f1ea6d790a89a5c44dec7448e350641bd1cb56e3e34d11fe0843247765b",
"md5": "038d17da5487fb500447294e104a0f60",
"sha256": "b0ab359029e845bc76966ef67dd3b5a7de0a9cba8b091c5b85d8770573de3dd2"
},
"downloads": -1,
"filename": "pyunisens-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "038d17da5487fb500447294e104a0f60",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16784,
"upload_time": "2023-10-30T16:17:21",
"upload_time_iso_8601": "2023-10-30T16:17:21.091229Z",
"url": "https://files.pythonhosted.org/packages/a4/61/7f1ea6d790a89a5c44dec7448e350641bd1cb56e3e34d11fe0843247765b/pyunisens-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-30 16:17:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Unisens",
"github_project": "pyUnisens",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "datetime",
"specs": []
}
],
"lcname": "pyunisens"
}
JSON
