{
    "info": {
        "author": "Pedro Gomes",
        "author_email": "pgomes92@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 2.7"
        ],
        "description": "# KUBIOS Import & Export for Python\n\nThis Python package enables easy exportation of NN/RR interval series or signals to KUBIOS HRV friendly files and structured formats and to import HRV analysis results from KUBIOS HRV report files in .txt format.\n\nThe exported signals are stored in the Type 1 format as presented on page 14 and 15 of the [KUBIOS User Guide](https://www.kubios.com/downloads/Kubios_HRV_Users_Guide.pdf).\n\n## How to Use this Package\n\n#### export_nni()\nUse the `export_nni()` function to export a series of NN/RR interval or ECG signal data to a KUBIOS readable file format.\n\n```python\nimport numpy as np\nfrom kubios import export_nni\n\n# Load NNI series\nnni = np.load('SampleSeries.npy')\n\n# Export NNI series\nexport_nni(nni)\n```\n\nUse the `output_path` variable to specify the file path where to store the exported file and `output_file` to specify the file name. Use only the `output_file` if you want to set the absolute file path in a single string. If no value for the `output_file` is provided, a file name (incl. time stamp) will automatically be generated.\n\n```python\nimport numpy as np\nfrom kubios import export_nni\n\n# Load NNI series\nnni = np.load('SampleSeries.npy')\n\n# Export NNI series with specific file name\nexport_nni(nni, output_file='export.txt)\n\n# Export NNI series to specific path & specific file name\nexport_nni(nni, output_path='/my/favorite/path/', output_file='export.txt')\n\n# Export NNI series to specific path with automatic file name generation\nexport_nni(nni, output_path='/my/favorite/path/')\n```\n\n#### import_report()\nUse the ```import_report()``` function to read a KUBIOS HRV report files in .txt format. The results will be returned in a Python dictionary.\n\n```python\nfrom kubios import import_report\n\n# Import HRV results from KUBIOS report\nresults = import_report('SampleReport.txt')\n\n# Get SDNN value\nresults['sdnn']\n```\n\n## Context of this Work\nThis package is under development within the scope of my master thesis _\"Development of an Open-Source Python Toolbox for Heart Rate Variability (HRV)\"_ at the [University of Applied Sciences Hamburg, Germany (Faculty Life Sciences, Department of Biomedical Engineering)](https://www.haw-hamburg.de/fakultaeten-und-departments/ls/studium-und-lehre/master-studiengaenge/mbme.html) and [PLUX wireless biosignals, S.A.](http://www.plux.info), Lisbon, Portugal.\n\n## Disclaimer\nThis package is not part of the official KUBIOS software.\n\nThis program is distributed in the hope it will be useful and provided to you \"as is\", but WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. This program is NOT intended for medical diagnosis. We expressly disclaim any liability whatsoever for any direct, indirect, consequential, incidental or special damages, including, without limitation, lost revenues, lost profits, losses resulting from business interruption or loss of data, regardless of the form of action or legal theory under which the liability may be asserted, even if advised of the possibility of such damages.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/PGomes92/kubios",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "kubios",
        "package_url": "https://pypi.org/project/kubios/",
        "platform": "",
        "project_url": "https://pypi.org/project/kubios/",
        "project_urls": {
            "Homepage": "https://github.com/PGomes92/kubios"
        },
        "release_url": "https://pypi.org/project/kubios/0.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Python package to support KUBIOS file management.",
        "version": "0.1"
    },
    "last_serial": 4373025,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c51718383f7fdb510d24ce1a4c27a93c",
                    "sha256": "f9445db38fed5e38db5e5ba20bcb659b2df644885ae20b8dc628da60885f107a"
                },
                "downloads": -1,
                "filename": "kubios-0.1-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "c51718383f7fdb510d24ce1a4c27a93c",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 6860,
                "upload_time": "2018-10-13T23:27:15",
                "url": "https://files.pythonhosted.org/packages/18/bc/70e6d48d7287c496b3c49d2a2978bc3c66719c73bb6b0ee58087fa30bac4/kubios-0.1-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "4e27f54359285ad9791ba0057d36bf06",
                    "sha256": "ed5c2d6071b7473ca6bab72337bfc2842cc28f4614b45fb14c7472d6b2fd7030"
                },
                "downloads": -1,
                "filename": "kubios-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "4e27f54359285ad9791ba0057d36bf06",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4894,
                "upload_time": "2018-10-13T23:27:17",
                "url": "https://files.pythonhosted.org/packages/5d/1f/ad6d32bb28a4ac74ebd0b6286a6c68bc6b1f381f2253218d7433b1c53f84/kubios-0.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c51718383f7fdb510d24ce1a4c27a93c",
                "sha256": "f9445db38fed5e38db5e5ba20bcb659b2df644885ae20b8dc628da60885f107a"
            },
            "downloads": -1,
            "filename": "kubios-0.1-py2-none-any.whl",
            "has_sig": false,
            "md5_digest": "c51718383f7fdb510d24ce1a4c27a93c",
            "packagetype": "bdist_wheel",
            "python_version": "py2",
            "requires_python": null,
            "size": 6860,
            "upload_time": "2018-10-13T23:27:15",
            "url": "https://files.pythonhosted.org/packages/18/bc/70e6d48d7287c496b3c49d2a2978bc3c66719c73bb6b0ee58087fa30bac4/kubios-0.1-py2-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "4e27f54359285ad9791ba0057d36bf06",
                "sha256": "ed5c2d6071b7473ca6bab72337bfc2842cc28f4614b45fb14c7472d6b2fd7030"
            },
            "downloads": -1,
            "filename": "kubios-0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4e27f54359285ad9791ba0057d36bf06",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4894,
            "upload_time": "2018-10-13T23:27:17",
            "url": "https://files.pythonhosted.org/packages/5d/1f/ad6d32bb28a4ac74ebd0b6286a6c68bc6b1f381f2253218d7433b1c53f84/kubios-0.1.tar.gz"
        }
    ]
}