| Name | pybsm JSON |
| Version |
0.10.1
JSON |
| download |
| home_page | None |
| Summary | pyBSM is a Python-based tool for sensor modeling. It provides common components useful for simulating the image formation process through different imaging systems. |
| upload_time | 2024-12-13 06:14:02 |
| maintainer | None |
| docs_url | None |
| author | Kitware, Inc. |
| requires_python | <4.0,>=3.9 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyBSM
pyBSM is a Python-based tool for sensor modeling. It provides common components useful for simulating the image formation process through different imaging systems.
This repo builds off of the work done by LeMaster and Eismann in creating the original pyBSM package for modeling image systems [[1]](#1) as well as LeMaster, et al. in their work in validating the pyBSM package [[2]](#2).
NOTE: A set of functions which infer OTFs from user data has been removed from
the current distribution of pyBSM. They are archived under the v0.7.0 tag if
they are needed.
## References
<a id="1">[1]</a>
LeMaster, Daniel A., and Michael T. Eismann. ‘pyBSM: A Python Package for Modeling Imaging Systems’. Society of Photo-Optical Instrumentation Engineers (SPIE) Conference Series, edited by Eric J. Kelmelis, vol. 10204, 2017, p. 1020405, https://doi.org10.1117/12.2262561. Society of Photo-Optical Instrumentation Engineers (SPIE) Conference Series.
<a id="2">[2]</a>
LeMaster, Daniel, et al. Validating pyBSM: A Python Package for Modeling Imaging Systems. 05 2018, p. 19, https://doi.org10.1117/12.2305228.
<!-- :auto installation: -->
## Installation
Ensure the source tree is acquired locally before proceeding.
To install the current version via `pip`:
```bash
pip install pybsm
```
Alternatively, you can use [Poetry](https://python-poetry.org/):
```bash
poetry install
```
For more detailed installation instructions, visit the [installation documentation](https://pybsm.readthedocs.io/en/latest/installation.html).
<!-- :auto installation: -->
<!-- :auto getting-started: -->
## Getting Started
Explore usage examples of the `pybsm` package in various contexts using the Jupyter notebooks provided in the `./examples/` directory.
Contributions are encouraged! For more details, refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
<!-- :auto getting-started: -->
<!-- :auto documentation: -->
## Documentation
Documentation for both release snapshots and the latest master branch is available on [ReadTheDocs](https://pybsm.readthedocs.io/en/latest/).
To build the Sphinx-based documentation locally for the latest reference:
```bash
# Install dependencies
poetry install --sync --with linting,tests,docs
# Navigate to the documentation root
cd docs
# Build the documentation
poetry run make html
# Open the generated documentation in your browser
firefox _build/html/index.html
```
<!-- :auto documentation: -->
<!-- :auto developer-tools: -->
## Developer Tools
### Pre-commit Hooks
Pre-commit hooks ensure that code complies with required linting and formatting guidelines. These hooks run automatically before commits but can also be executed manually. To bypass checks during a commit, use the `--no-verify` flag.
To install and use pre-commit hooks:
```bash
# Install required dependencies
poetry install --sync --with linting,tests,docs
# Initialize pre-commit hooks for the repository
poetry run pre-commit install
# Run pre-commit checks on all files
poetry run pre-commit run --all-files
```
<!-- :auto developer-tools: -->
<!-- :auto contributing: -->
## Contributing
- Follow the [JATIC Design Principles](https://cdao.pages.jatic.net/public/program/design-principles/).
- Adopt the Git Flow branching strategy.
- Detailed release information is available in [docs/release_process.rst](./docs/release_process.rst).
- Additional contribution guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).
<!-- :auto contributing: -->
<!-- :auto license: -->
## License
[Apache 2.0](./LICENSE)
<!-- :auto license: -->
<!-- :auto contacts: -->
## Contacts
**Principal Investigator**: Brian Hu (Kitware) @brian.hu
**Product Owner**: Austin Whitesell (MITRE) @awhitesell
**Scrum Master / Tech Lead**: Brandon RichardWebster (Kitware) @b.richardwebster
**Deputy Tech Lead**: Emily Veenhuis (Kitware) @emily.veenhuis
<!-- :auto contacts: -->
Raw data
{
"_id": null,
"home_page": null,
"name": "pybsm",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Kitware, Inc.",
"author_email": "nrtk@kitware.com",
"download_url": "https://files.pythonhosted.org/packages/bf/bb/30ca5827c9a58dbd799ff9cad7bb364b616f208757277b432731e2abc252/pybsm-0.10.1.tar.gz",
"platform": null,
"description": "# pyBSM\n\npyBSM is a Python-based tool for sensor modeling. It provides common components useful for simulating the image formation process through different imaging systems.\n\nThis repo builds off of the work done by LeMaster and Eismann in creating the original pyBSM package for modeling image systems [[1]](#1) as well as LeMaster, et al. in their work in validating the pyBSM package [[2]](#2).\n\nNOTE: A set of functions which infer OTFs from user data has been removed from\nthe current distribution of pyBSM. They are archived under the v0.7.0 tag if\nthey are needed.\n\n## References\n<a id=\"1\">[1]</a>\nLeMaster, Daniel A., and Michael T. Eismann. \u2018pyBSM: A Python Package for Modeling Imaging Systems\u2019. Society of Photo-Optical Instrumentation Engineers (SPIE) Conference Series, edited by Eric J. Kelmelis, vol. 10204, 2017, p. 1020405, https://doi.org10.1117/12.2262561. Society of Photo-Optical Instrumentation Engineers (SPIE) Conference Series.\n\n<a id=\"2\">[2]</a>\nLeMaster, Daniel, et al. Validating pyBSM: A Python Package for Modeling Imaging Systems. 05 2018, p. 19, https://doi.org10.1117/12.2305228.\n\n<!-- :auto installation: -->\n## Installation\nEnsure the source tree is acquired locally before proceeding.\n\nTo install the current version via `pip`:\n```bash\npip install pybsm\n```\n\nAlternatively, you can use [Poetry](https://python-poetry.org/):\n```bash\npoetry install\n```\n\nFor more detailed installation instructions, visit the [installation documentation](https://pybsm.readthedocs.io/en/latest/installation.html).\n<!-- :auto installation: -->\n\n<!-- :auto getting-started: -->\n## Getting Started\nExplore usage examples of the `pybsm` package in various contexts using the Jupyter notebooks provided in the `./examples/` directory.\n\nContributions are encouraged! For more details, refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n<!-- :auto getting-started: -->\n\n<!-- :auto documentation: -->\n## Documentation\nDocumentation for both release snapshots and the latest master branch is available on [ReadTheDocs](https://pybsm.readthedocs.io/en/latest/).\n\nTo build the Sphinx-based documentation locally for the latest reference:\n```bash\n# Install dependencies\npoetry install --sync --with linting,tests,docs\n# Navigate to the documentation root\ncd docs\n# Build the documentation\npoetry run make html\n# Open the generated documentation in your browser\nfirefox _build/html/index.html\n```\n<!-- :auto documentation: -->\n\n<!-- :auto developer-tools: -->\n## Developer Tools\n\n### Pre-commit Hooks\nPre-commit hooks ensure that code complies with required linting and formatting guidelines. These hooks run automatically before commits but can also be executed manually. To bypass checks during a commit, use the `--no-verify` flag.\n\nTo install and use pre-commit hooks:\n```bash\n# Install required dependencies\npoetry install --sync --with linting,tests,docs\n# Initialize pre-commit hooks for the repository\npoetry run pre-commit install\n# Run pre-commit checks on all files\npoetry run pre-commit run --all-files\n```\n<!-- :auto developer-tools: -->\n\n<!-- :auto contributing: -->\n## Contributing\n- Follow the [JATIC Design Principles](https://cdao.pages.jatic.net/public/program/design-principles/).\n- Adopt the Git Flow branching strategy.\n- Detailed release information is available in [docs/release_process.rst](./docs/release_process.rst).\n- Additional contribution guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).\n<!-- :auto contributing: -->\n\n<!-- :auto license: -->\n## License\n[Apache 2.0](./LICENSE)\n<!-- :auto license: -->\n\n<!-- :auto contacts: -->\n## Contacts\n\n**Principal Investigator**: Brian Hu (Kitware) @brian.hu\n**Product Owner**: Austin Whitesell (MITRE) @awhitesell\n**Scrum Master / Tech Lead**: Brandon RichardWebster (Kitware) @b.richardwebster\n**Deputy Tech Lead**: Emily Veenhuis (Kitware) @emily.veenhuis\n<!-- :auto contacts: -->\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "pyBSM is a Python-based tool for sensor modeling. It provides common components useful for simulating the image formation process through different imaging systems.",
"version": "0.10.1",
"project_urls": {
"Documentation": "https://pybsm.readthedocs.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0360f11b74200033893dac9a79f3db1587b33440d86697e3d8bab1ba31048202",
"md5": "9b235c0d1af700b7a47808730175b267",
"sha256": "cc2e49226594ae234e07ef2daa3b0f0253d6083074e8bfb58dbbfd33a9a289a5"
},
"downloads": -1,
"filename": "pybsm-0.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b235c0d1af700b7a47808730175b267",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 77815053,
"upload_time": "2024-12-13T06:13:48",
"upload_time_iso_8601": "2024-12-13T06:13:48.546653Z",
"url": "https://files.pythonhosted.org/packages/03/60/f11b74200033893dac9a79f3db1587b33440d86697e3d8bab1ba31048202/pybsm-0.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bfbb30ca5827c9a58dbd799ff9cad7bb364b616f208757277b432731e2abc252",
"md5": "12e99bb1f5fe5485640f2d4c9058c3a0",
"sha256": "7589ad5f9a9bae22c9bbf1ec3ddee40192097523db6d5ee14cc50f0e29166ef6"
},
"downloads": -1,
"filename": "pybsm-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "12e99bb1f5fe5485640f2d4c9058c3a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 76470708,
"upload_time": "2024-12-13T06:14:02",
"upload_time_iso_8601": "2024-12-13T06:14:02.485276Z",
"url": "https://files.pythonhosted.org/packages/bf/bb/30ca5827c9a58dbd799ff9cad7bb364b616f208757277b432731e2abc252/pybsm-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 06:14:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pybsm"
}
