python-ins


Namepython-ins JSON
Version 1.0.1 PyPI version JSON
download
home_page
SummaryInertial Navigation System algorithms in Python
upload_time2024-02-08 19:12:40
maintainer
docs_urlNone
author
requires_python
licenseMIT License Copyright (c) 2023 Nikolay Mayorov 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 navigation ins inertial navigation kalman filters
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![tests status](https://github.com/nmayorov/pyins/actions/workflows/build_and_test.yaml/badge.svg)
![documentation status](https://readthedocs.org/projects/pyins/badge/?version=latest)

# pyins

pyins is a Python package which provides common basic algorithms used in Inertial Navigation Systems (INS) aided by external sensors like GNSS.

Version 1.0 has refined and improved functionality, consistent docstrings and extended examples.
Refer to [version_1.0.md](./version_1.0.md) for the list of main changes compared to earlier versions.

## Installation

The package now is pure Python and thus can be easily installed on any platform.

### Installing from pypi

Due to pypi policies the distribution package name is "python-ins".
```shell
pip install python-ins
```

### 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):

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

## Running tests

To run all the supplied tests with `pytest` execute: 
```shell
pytest --pyargs pyins
```
Due to some `pytest` limitations it won't work for the editable installation. 
In this case supply path to `tests` directory:
```shell
pytest /your_dev_dir/pyins/pyins/tests
```

## Documentation

Documentation is available here https://pyins.readthedocs.io.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "python-ins",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "Nikolay Mayorov <nikolay.mayorov@zoho.com>",
    "keywords": "Navigation,INS,Inertial navigation,Kalman filters",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/e2/ee/780582392c9691c8b31ae0a0cecc54b054f8bbca3a8671038779100ac7b0/python-ins-1.0.1.tar.gz",
    "platform": null,
    "description": "![tests status](https://github.com/nmayorov/pyins/actions/workflows/build_and_test.yaml/badge.svg)\n![documentation status](https://readthedocs.org/projects/pyins/badge/?version=latest)\n\n# pyins\n\npyins is a Python package which provides common basic algorithms used in Inertial Navigation Systems (INS) aided by external sensors like GNSS.\n\nVersion 1.0 has refined and improved functionality, consistent docstrings and extended examples.\nRefer to [version_1.0.md](./version_1.0.md) for the list of main changes compared to earlier versions.\n\n## Installation\n\nThe package now is pure Python and thus can be easily installed on any platform.\n\n### Installing from pypi\n\nDue to pypi policies the distribution package name is \"python-ins\".\n```shell\npip install python-ins\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* numba (0.58.0)\n* numpy (1.25.2)\n* scipy (1.11.3)\n* pandas (2.1.1)\n\n## Running tests\n\nTo run all the supplied tests with `pytest` execute: \n```shell\npytest --pyargs pyins\n```\nDue to some `pytest` limitations it won't work for the editable installation. \nIn this case supply path to `tests` directory:\n```shell\npytest /your_dev_dir/pyins/pyins/tests\n```\n\n## Documentation\n\nDocumentation is available here https://pyins.readthedocs.io.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Nikolay Mayorov  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": "Inertial Navigation System algorithms in Python",
    "version": "1.0.1",
    "project_urls": {
        "Documentation": "https://pyins.readthedocs.io",
        "Homepage": "https://github.com/nmayorov/pyins"
    },
    "split_keywords": [
        "navigation",
        "ins",
        "inertial navigation",
        "kalman filters"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "dd2cfa2c7f7befab2b2ffd122451941f42dbeba96153bcb93928cdcba35b5fc1",
                "md5": "067c06028654e605072fdf1b1e258e72",
                "sha256": "61f4ce8d2a72f4f8535d8151377f63817f0c9e7354e344940f0ba335e6008f48"
            },
            "downloads": -1,
            "filename": "python_ins-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "067c06028654e605072fdf1b1e258e72",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 51790,
            "upload_time": "2024-02-08T19:12:38",
            "upload_time_iso_8601": "2024-02-08T19:12:38.638413Z",
            "url": "https://files.pythonhosted.org/packages/dd/2c/fa2c7f7befab2b2ffd122451941f42dbeba96153bcb93928cdcba35b5fc1/python_ins-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e2ee780582392c9691c8b31ae0a0cecc54b054f8bbca3a8671038779100ac7b0",
                "md5": "5ff2726455f101a98029ed093f960148",
                "sha256": "9f350c0d2af15c443da9792e22e309075a99f8cf4030f6ba728acfb56e440175"
            },
            "downloads": -1,
            "filename": "python-ins-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "5ff2726455f101a98029ed093f960148",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 43129,
            "upload_time": "2024-02-08T19:12:40",
            "upload_time_iso_8601": "2024-02-08T19:12:40.191796Z",
            "url": "https://files.pythonhosted.org/packages/e2/ee/780582392c9691c8b31ae0a0cecc54b054f8bbca3a8671038779100ac7b0/python-ins-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-08 19:12:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nmayorov",
    "github_project": "pyins",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "python-ins"
}
        
Elapsed time: 0.18116s