| Name | sleep-scoring JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | None |
| Summary | Standalone version of Sleep module from Visbrain suite. |
| upload_time | 2024-09-07 02:12:28 |
| maintainer | Anjo Pagdanganan |
| docs_url | None |
| author | Visbrain developers |
| requires_python | None |
| license | New BSD License Copyright (c) 2007–2017 The Visbrain developers. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: a. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. b. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. c. Neither the name of the Visbrain Developers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
brain
mni
gpu
visualization
data
opengl
vispy
neuroscience
sleep
data-mining
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
|
| coveralls test coverage |
|
sleep-scoring
==================
Sleep is a flexible open-source graphical user interface for visualization, analysis and scoring of polysomnographic sleep data.
It was originally developed by Etienne Combrisson in collaboration with Raphael Vallat and Christian O Reilly.
This standalone version was devleoped by Anjo Pagdanganan under the guidance of Omer Sharon at the Center for Human Sleep Sciene at UC Berkeley in order to allow direct installation in a contemporary python environment.
It also includes some bug fixes and new features, such as:
* Signal graph backgrounds colored according to hypnogram
* Hypnogram live updates during scoring
* Option to save old and new formats for hypnogram data
.. image:: /docs/picture/picsleep/sleep_info.png
A copy of the relevant documentation is provided `in this repo <https://github.com/x64-bit/sleep-scoring/blob/main/docs/sleep.rst>`_, but can also be found at the `original Visbrain repo <https://github.com/EtienneCmb/visbrain/blob/master/docs/sleep.rst>`_.
This copy contains not just the documentation for Sleep, but also the rest of Visbrain's documentation for archival purposes.
Example code can be found under `examples/gui_sleep <https://github.com/x64-bit/sleep-scoring/tree/main/examples/gui_sleep>`_
Installation
=================
It is recommended to install this in a virtual environment using conda. This package was developed on Python 3.12 but has been shown to work with Python >= 3.9.::
python -m pip install sleep-scoring
(It is recommended to preface `pip` with `python -m` to ensure it uses the virtual environment's installation of python)
Start scoring
=================
Sleep can be deployed using this python script (see `examples/basic_sleep.py`)::
from sleep_scoring.gui import Sleep
Sleep().show()
You can either start Python in the terminal with the `python` command and write the commands there, or you can create a python script and run it.
Citation
=========
Combrisson E, Vallat R, Eichenlaub J-B, O'Reilly C, Lajnef T, Guillot A, Ruby PM and Jerbi K (2017) Sleep: An Open-Source Python Software for Visualization, Analysis, and Staging of Sleep Data. Front. Neuroinform. 11:60. doi: 10.3389/fninf.2017.00060
Raw data
{
"_id": null,
"home_page": null,
"name": "sleep-scoring",
"maintainer": "Anjo Pagdanganan",
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "brain MNI GPU visualization data OpenGL vispy neuroscience sleep data-mining",
"author": "Visbrain developers",
"author_email": "anjopag31@berkeley.edu",
"download_url": "https://files.pythonhosted.org/packages/d2/f0/d28595036062598d458447dfc0321e2da007d1dbcce9f038c161a24c5d21/sleep_scoring-0.0.4.tar.gz",
"platform": "any",
"description": "sleep-scoring\n==================\n\nSleep is a flexible open-source graphical user interface for visualization, analysis and scoring of polysomnographic sleep data. \nIt was originally developed by Etienne Combrisson in collaboration with Raphael Vallat and Christian O Reilly. \nThis standalone version was devleoped by Anjo Pagdanganan under the guidance of Omer Sharon at the Center for Human Sleep Sciene at UC Berkeley in order to allow direct installation in a contemporary python environment.\nIt also includes some bug fixes and new features, such as:\n\n* Signal graph backgrounds colored according to hypnogram\n* Hypnogram live updates during scoring\n* Option to save old and new formats for hypnogram data\n\n.. image:: /docs/picture/picsleep/sleep_info.png\n\nA copy of the relevant documentation is provided `in this repo <https://github.com/x64-bit/sleep-scoring/blob/main/docs/sleep.rst>`_, but can also be found at the `original Visbrain repo <https://github.com/EtienneCmb/visbrain/blob/master/docs/sleep.rst>`_. \nThis copy contains not just the documentation for Sleep, but also the rest of Visbrain's documentation for archival purposes.\n\nExample code can be found under `examples/gui_sleep <https://github.com/x64-bit/sleep-scoring/tree/main/examples/gui_sleep>`_\n\nInstallation\n=================\n\nIt is recommended to install this in a virtual environment using conda. This package was developed on Python 3.12 but has been shown to work with Python >= 3.9.::\n\n python -m pip install sleep-scoring \n\n(It is recommended to preface `pip` with `python -m` to ensure it uses the virtual environment's installation of python)\n\nStart scoring\n=================\n\nSleep can be deployed using this python script (see `examples/basic_sleep.py`)::\n\n from sleep_scoring.gui import Sleep\n\n Sleep().show()\n\n\nYou can either start Python in the terminal with the `python` command and write the commands there, or you can create a python script and run it.\n\nCitation\n=========\n\nCombrisson E, Vallat R, Eichenlaub J-B, O'Reilly C, Lajnef T, Guillot A, Ruby PM and Jerbi K (2017) Sleep: An Open-Source Python Software for Visualization, Analysis, and Staging of Sleep Data. Front. Neuroinform. 11:60. doi: 10.3389/fninf.2017.00060\n",
"bugtrack_url": null,
"license": "New BSD License Copyright (c) 2007\u20132017 The Visbrain developers. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: a. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. b. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. c. Neither the name of the Visbrain Developers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Standalone version of Sleep module from Visbrain suite.",
"version": "0.0.4",
"project_urls": {
"Download": "https://github.com/x64-bit/sleep-scoring"
},
"split_keywords": [
"brain",
"mni",
"gpu",
"visualization",
"data",
"opengl",
"vispy",
"neuroscience",
"sleep",
"data-mining"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d9d3d29d1674ef2342be134463b3ac9b78f4b4138a5157adf6b91eda6846bda2",
"md5": "3006e010949c285cc5ee11b5487014d6",
"sha256": "59e64c12d1ed13024477f17a9bbc652ce0a80e1abfa171ba02ffa2f16183d3f6"
},
"downloads": -1,
"filename": "sleep_scoring-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3006e010949c285cc5ee11b5487014d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 231208,
"upload_time": "2024-09-07T02:12:26",
"upload_time_iso_8601": "2024-09-07T02:12:26.958720Z",
"url": "https://files.pythonhosted.org/packages/d9/d3/d29d1674ef2342be134463b3ac9b78f4b4138a5157adf6b91eda6846bda2/sleep_scoring-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d2f0d28595036062598d458447dfc0321e2da007d1dbcce9f038c161a24c5d21",
"md5": "f6844085f8aa75a2f995134b658deed9",
"sha256": "22c4aec74e901aa934ceb4bd0d8d5ed94e680da3d92cc31158a48654b0fa7f7d"
},
"downloads": -1,
"filename": "sleep_scoring-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "f6844085f8aa75a2f995134b658deed9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 195994,
"upload_time": "2024-09-07T02:12:28",
"upload_time_iso_8601": "2024-09-07T02:12:28.557319Z",
"url": "https://files.pythonhosted.org/packages/d2/f0/d28595036062598d458447dfc0321e2da007d1dbcce9f038c161a24c5d21/sleep_scoring-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-07 02:12:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "x64-bit",
"github_project": "sleep-scoring",
"travis_ci": true,
"coveralls": true,
"github_actions": false,
"appveyor": true,
"circle": true,
"lcname": "sleep-scoring"
}
