| Name | serums JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | A Python package for Statistical Error and Risk Utility for Multi-sensor Systems (SERUMS). |
| upload_time | 2023-04-26 13:44:19 |
| maintainer | |
| docs_url | None |
| author | Laboratory for Autonomy GNC and Estimation Research (LAGER) |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2022 Jordan D Larson 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 |
statistical error
overbounding
gaussian distributions
multi-sensor systems
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
SERUMS
======
A Python package for Statistical Error and Risk Utility for Multi-sensor Systems (SERUMS) developed by the Laboratory for Autonomy, GNC, and Estimation Research (LAGER) at the University of Alabama (UA).
.. contents:: Table of Contents
:depth: 2
:local:
..
BEGIN LINKS INCLUDE
.. |Open in Dev Containers| image:: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode
:target: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/drjdlarson/serums.git
.. |Test Status| image:: https://drjdlarson.github.io/serums/reports/junit/tests-badge.svg?dummy=8484744
:target: https://drjdlarson.github.io/serums/reports/junit/junit.html
.. |Test Cov| image:: https://drjdlarson.github.io/serums/reports/coverage/coverage-badge.svg?dummy=8484744
:target: https://drjdlarson.github.io/serums/reports/coverage/index.html
..
END LINKS INCLUDE
|Open in Dev Containers| |Test Status| |Test Cov|
..
BEGIN TOOLCHAIN INCLUDE
This project uses the pytest for developing and running the tests (with extensions for generating summary and coverage reports), tox automates setting up and running the test environment (as well as the documentation), Sphinx is used for documenting the code, and the Black formatter is used to auto format the python code. This project also follows `semantic versioning <https://semver.org/>`__ where any api breaking changes will increment the major version number. Additionally, a prebuilt docker container image is provided to get started with developing for this library. It contains all of the needed tools to compile the code, run the tests, and build the documentation. The docker container can be used within VS Code through their dev container extension to allow editing local files but compiling using the toolchain provided within the container.
Development Environment Setup
-----------------------------
It is recommended to use VS Code with the dev containers extension for developing. Development containers allow the full toolchain to be automatically setup on most any machine capable of running Docker. For information on dev-containers see `here <https://code.visualstudio.com/docs/devcontainers/containers>`__ for an overview, `here <https://stackoverflow.com/questions/71402603/vs-code-in-docker-container-is-there-a-way-to-automatically-install-extensions>`__ for auto installing extensions in the container
and `here <https://pspdfkit.com/blog/2020/visual-studio-code-cpp-docker/>`__ for an example setup. The provided dev container also has useful extensions installed to ease development.
To being, make sure VS Code and git are installed. Additionally, make sure docker is installed for your system (`Windows <https://docs.docker.com/desktop/install/windows-install/>`__, `Mac <https://docs.docker.com/desktop/install/mac-install/>`_, `Linux <https://docs.docker.com/engine/install/>`__). Next, install the dev containers extension within VS Code. Clone the repository locally on your computer, for windows it is recommended to clone it within your linux subsystem directory (e.g. a sub-directory of your linux home folder) to improve performance within the container (the linux directories on Windows can be accessed through the file browser by typing :code:`\\wsl$` in the address bar and clicking on your distro). Now open the repo folder within VS Code (for windows you may need to connect to the linux subsystem first). Then you should be prompted to open the folder in the container, click yes. If you are not prompted, you can go to the command palette and start typing "Open folder in container". Now your terminal within VS Code will be running commands within the container but the files your are editing/creating will be accessible from your local machine's file browser.
Note if you click the open in container button on the repo's page it will automatically open VS Code, open the container, and clone the repo for you. However, it will do this within a docker volume so the files are only accessible within the container (ie you can't view them through your local file browser).
Example Workflow
----------------
Once the repository is open in the container, you can edit files, run tests, and make commits just like normal. For example, after editing some files and adding some validation tests to run these tests you would simply call the following from the root of the repository.
.. code-block::
tox
This will attempt to run the all the validation tests, except those marked as slow, on multiple versions of python. If the python version can not be found, it will be skipped.
After running tests, it may be helpful to check the documentation build locally to ensure code comments are being pulled correctly. This can be done with
.. code-block::
tox -e clean_docs
tox -e docs_html
to remove any existing documenation builds and generate the html version. The output is placed in **docs/build/html** and can be viewed by opening the **docs/build/html/index.html** file in your web browser.
Notes on tox
------------
Tox will automatically create virtual environements, install dependencies, install the package, and run some commands in the virtual environment. These are defined in the **tox.ini** file in the repository. If tox is called without specifying an envrionment, it will run all of the default environments. The available environments can be listed with
.. code-block::
tox -av
and a specific environment run by calling
.. code-block::
tox -e ENV
where :code:`ENV` is replaced with the environment name. To pass positional arguments into the commands run within the tox environment you must use :code:`--` after the environment name but before the positional arguments. For example to run validation tests using Python 3.9 and pass the :code:`--runslow` option to pytest you would call :code:`tox -e py39-validation_test -- --runslow`.
Note, all tox commands must be run from the root of the repository because this is where the **tox.ini** file lives.
..
END TOOLCHAIN INCLUDE
..
BEGIN CITE INCLUDE
Cite
====
Please cite the framework as follows
.. code-block:: bibtex
@Misc{serums,
author = {Jordan D. Larson, et al.},
howpublished = {Web page},
title = {{SERUMS}: A Python library for Statistical Error and Risk Utility for Multi-sensor Systems},
year = {2022},
url = {https://github.com/drjdlarson/serums},
}
..
END CITE INCLUDE
Raw data
{
"_id": null,
"home_page": "",
"name": "serums",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Statistical error,overbounding,Gaussian distributions,multi-sensor systems",
"author": "Laboratory for Autonomy GNC and Estimation Research (LAGER)",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/8f/56/63fe676f5ed95a70bc5cf771ad6796f551b28edd6580307f1a5d692ee131/serums-1.0.0.tar.gz",
"platform": null,
"description": "SERUMS\n======\n\nA Python package for Statistical Error and Risk Utility for Multi-sensor Systems (SERUMS) developed by the Laboratory for Autonomy, GNC, and Estimation Research (LAGER) at the University of Alabama (UA).\n\n.. contents:: Table of Contents\n :depth: 2\n :local:\n\n..\n BEGIN LINKS INCLUDE\n\n.. |Open in Dev Containers| image:: https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode\n :target: https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/drjdlarson/serums.git\n\n.. |Test Status| image:: https://drjdlarson.github.io/serums/reports/junit/tests-badge.svg?dummy=8484744\n :target: https://drjdlarson.github.io/serums/reports/junit/junit.html\n\n.. |Test Cov| image:: https://drjdlarson.github.io/serums/reports/coverage/coverage-badge.svg?dummy=8484744\n :target: https://drjdlarson.github.io/serums/reports/coverage/index.html\n\n..\n END LINKS INCLUDE\n\n|Open in Dev Containers| |Test Status| |Test Cov|\n\n..\n BEGIN TOOLCHAIN INCLUDE\n\nThis project uses the pytest for developing and running the tests (with extensions for generating summary and coverage reports), tox automates setting up and running the test environment (as well as the documentation), Sphinx is used for documenting the code, and the Black formatter is used to auto format the python code. This project also follows `semantic versioning <https://semver.org/>`__ where any api breaking changes will increment the major version number. Additionally, a prebuilt docker container image is provided to get started with developing for this library. It contains all of the needed tools to compile the code, run the tests, and build the documentation. The docker container can be used within VS Code through their dev container extension to allow editing local files but compiling using the toolchain provided within the container.\n\n\nDevelopment Environment Setup\n-----------------------------\nIt is recommended to use VS Code with the dev containers extension for developing. Development containers allow the full toolchain to be automatically setup on most any machine capable of running Docker. For information on dev-containers see `here <https://code.visualstudio.com/docs/devcontainers/containers>`__ for an overview, `here <https://stackoverflow.com/questions/71402603/vs-code-in-docker-container-is-there-a-way-to-automatically-install-extensions>`__ for auto installing extensions in the container\nand `here <https://pspdfkit.com/blog/2020/visual-studio-code-cpp-docker/>`__ for an example setup. The provided dev container also has useful extensions installed to ease development.\n\nTo being, make sure VS Code and git are installed. Additionally, make sure docker is installed for your system (`Windows <https://docs.docker.com/desktop/install/windows-install/>`__, `Mac <https://docs.docker.com/desktop/install/mac-install/>`_, `Linux <https://docs.docker.com/engine/install/>`__). Next, install the dev containers extension within VS Code. Clone the repository locally on your computer, for windows it is recommended to clone it within your linux subsystem directory (e.g. a sub-directory of your linux home folder) to improve performance within the container (the linux directories on Windows can be accessed through the file browser by typing :code:`\\\\wsl$` in the address bar and clicking on your distro). Now open the repo folder within VS Code (for windows you may need to connect to the linux subsystem first). Then you should be prompted to open the folder in the container, click yes. If you are not prompted, you can go to the command palette and start typing \"Open folder in container\". Now your terminal within VS Code will be running commands within the container but the files your are editing/creating will be accessible from your local machine's file browser.\n\nNote if you click the open in container button on the repo's page it will automatically open VS Code, open the container, and clone the repo for you. However, it will do this within a docker volume so the files are only accessible within the container (ie you can't view them through your local file browser).\n\n\nExample Workflow\n----------------\nOnce the repository is open in the container, you can edit files, run tests, and make commits just like normal. For example, after editing some files and adding some validation tests to run these tests you would simply call the following from the root of the repository.\n\n.. code-block:: \n\n tox\n\nThis will attempt to run the all the validation tests, except those marked as slow, on multiple versions of python. If the python version can not be found, it will be skipped.\n\nAfter running tests, it may be helpful to check the documentation build locally to ensure code comments are being pulled correctly. This can be done with\n\n.. code-block:: \n\n tox -e clean_docs\n tox -e docs_html\n\nto remove any existing documenation builds and generate the html version. The output is placed in **docs/build/html** and can be viewed by opening the **docs/build/html/index.html** file in your web browser.\n\n\nNotes on tox\n------------\nTox will automatically create virtual environements, install dependencies, install the package, and run some commands in the virtual environment. These are defined in the **tox.ini** file in the repository. If tox is called without specifying an envrionment, it will run all of the default environments. The available environments can be listed with\n\n.. code-block:: \n\n tox -av\n\nand a specific environment run by calling\n\n.. code-block:: \n\n tox -e ENV\n\nwhere :code:`ENV` is replaced with the environment name. To pass positional arguments into the commands run within the tox environment you must use :code:`--` after the environment name but before the positional arguments. For example to run validation tests using Python 3.9 and pass the :code:`--runslow` option to pytest you would call :code:`tox -e py39-validation_test -- --runslow`.\n\nNote, all tox commands must be run from the root of the repository because this is where the **tox.ini** file lives.\n\n..\n END TOOLCHAIN INCLUDE\n\n.. \n BEGIN CITE INCLUDE\n\nCite\n====\nPlease cite the framework as follows\n\n.. code-block:: bibtex\n\n @Misc{serums,\n author = {Jordan D. Larson, et al.},\n howpublished = {Web page},\n title = {{SERUMS}: A Python library for Statistical Error and Risk Utility for Multi-sensor Systems},\n year = {2022},\n url = {https://github.com/drjdlarson/serums},\n }\n\n..\n END CITE INCLUDE\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Jordan D Larson 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": "A Python package for Statistical Error and Risk Utility for Multi-sensor Systems (SERUMS).",
"version": "1.0.0",
"split_keywords": [
"statistical error",
"overbounding",
"gaussian distributions",
"multi-sensor systems"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "10481b00ce8dcdad54d916513ca25c1d14a6725e63d86e409d41dc78c4a48720",
"md5": "38e5cb37c7c1a21145acc73eca8f0bcf",
"sha256": "bce791cdf698f967cb43894f647ab08ee983b57a674fd16939b63cf5e8b0230e"
},
"downloads": -1,
"filename": "serums-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38e5cb37c7c1a21145acc73eca8f0bcf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 33068,
"upload_time": "2023-04-26T13:44:17",
"upload_time_iso_8601": "2023-04-26T13:44:17.531959Z",
"url": "https://files.pythonhosted.org/packages/10/48/1b00ce8dcdad54d916513ca25c1d14a6725e63d86e409d41dc78c4a48720/serums-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8f5663fe676f5ed95a70bc5cf771ad6796f551b28edd6580307f1a5d692ee131",
"md5": "dc6e482190bc04d256572e6c70cb60c2",
"sha256": "8dc7e001591b86e30a3d0ed89274576586e3c5bbd9c2d861c718a9d29559cdf8"
},
"downloads": -1,
"filename": "serums-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "dc6e482190bc04d256572e6c70cb60c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 136782,
"upload_time": "2023-04-26T13:44:19",
"upload_time_iso_8601": "2023-04-26T13:44:19.506097Z",
"url": "https://files.pythonhosted.org/packages/8f/56/63fe676f5ed95a70bc5cf771ad6796f551b28edd6580307f1a5d692ee131/serums-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-26 13:44:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "serums"
}
