allan-variance


Nameallan-variance JSON
Version 1.0 PyPI version JSON
download
home_page
SummaryAllan variance and noise parameter estimation
upload_time2024-03-18 19:43:40
maintainer
docs_urlNone
author
requires_python
licenseMIT License Copyright (c) Nikolay Mayorov 2024 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords allan variance estimation noise
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![tests status](https://github.com/nmayorov/allan-variance/actions/workflows/build_and_test.yaml/badge.svg)

# allan_variance

Simple Python package to compute Allan variance and estimate noise parameters from it.
It also provides a power-law spectrum noise generator for simulation purposes.
The application in mind was analysis of random noise in inertial sensors.

## Installation

### Installing from pypi

```shell
pip install allan-variance
```

### Installing from source

To perform a regular install, execute in the cloned repository directory: 
```shell
pip install .
```
To perform an editable (inplace) install:
```shell
pip install -e .
```

## Dependencies

Runtime dependencies include (versions in parentheses were used for the latest development):

* numpy (1.25.2)
* scipy (1.11.3)
* pandas (2.1.1)

## Examples

An [example](https://github.com/nmayorov/allan-variance/blob/master/example.ipynb) included in 
the repository demonstrates usage.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "allan-variance",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "Nikolay Mayorov <nikolay.mayorov@zoho.com>",
    "keywords": "Allan Variance,Estimation,Noise",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/e9/84/ee39e837099dcd57e71296396bcc3a6c1fa02f0777a7ca118f73ac0d10fc/allan-variance-1.0.tar.gz",
    "platform": null,
    "description": "![tests status](https://github.com/nmayorov/allan-variance/actions/workflows/build_and_test.yaml/badge.svg)\n\n# allan_variance\n\nSimple Python package to compute Allan variance and estimate noise parameters from it.\nIt also provides a power-law spectrum noise generator for simulation purposes.\nThe application in mind was analysis of random noise in inertial sensors.\n\n## Installation\n\n### Installing from pypi\n\n```shell\npip install allan-variance\n```\n\n### Installing from source\n\nTo perform a regular install, execute in the cloned repository directory: \n```shell\npip install .\n```\nTo perform an editable (inplace) install:\n```shell\npip install -e .\n```\n\n## Dependencies\n\nRuntime dependencies include (versions in parentheses were used for the latest development):\n\n* numpy (1.25.2)\n* scipy (1.11.3)\n* pandas (2.1.1)\n\n## Examples\n\nAn [example](https://github.com/nmayorov/allan-variance/blob/master/example.ipynb) included in \nthe repository demonstrates usage.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) Nikolay Mayorov 2024  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Allan variance and noise parameter estimation",
    "version": "1.0",
    "project_urls": {
        "Homepage": "https://github.com/nmayorov/allan-variance"
    },
    "split_keywords": [
        "allan variance",
        "estimation",
        "noise"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "741a2e4d0627fa1d31ee6ed85d37a2d9b41a1add5622b026e969dfb8a35dab0e",
                "md5": "07a81da0f6a93da99018d2c3b5dbee42",
                "sha256": "32ca617f976c76f31b036260e801551d8eb52cb58a099612967d3d2b36bf0127"
            },
            "downloads": -1,
            "filename": "allan_variance-1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "07a81da0f6a93da99018d2c3b5dbee42",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8568,
            "upload_time": "2024-03-18T19:43:38",
            "upload_time_iso_8601": "2024-03-18T19:43:38.928888Z",
            "url": "https://files.pythonhosted.org/packages/74/1a/2e4d0627fa1d31ee6ed85d37a2d9b41a1add5622b026e969dfb8a35dab0e/allan_variance-1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e984ee39e837099dcd57e71296396bcc3a6c1fa02f0777a7ca118f73ac0d10fc",
                "md5": "2c625a5bf688a3e70d74fa8aaa9bd138",
                "sha256": "a180665eaf8220bf7277a9f442ede6b9338f5e346f544721ea04473a2d268253"
            },
            "downloads": -1,
            "filename": "allan-variance-1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "2c625a5bf688a3e70d74fa8aaa9bd138",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6826,
            "upload_time": "2024-03-18T19:43:40",
            "upload_time_iso_8601": "2024-03-18T19:43:40.986372Z",
            "url": "https://files.pythonhosted.org/packages/e9/84/ee39e837099dcd57e71296396bcc3a6c1fa02f0777a7ca118f73ac0d10fc/allan-variance-1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-18 19:43:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nmayorov",
    "github_project": "allan-variance",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "allan-variance"
}
        
Elapsed time: 0.39058s