Name | nireports JSON |
Version |
25.3.0
JSON |
| download |
home_page | None |
Summary | NiReports - The Visual Report System (VRS) of NiPreps |
upload_time | 2025-09-11 01:41:46 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.10 |
license | None |
keywords |
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
.. image:: https://img.shields.io/pypi/v/nireports.svg
:target: https://pypi.python.org/pypi/nireports/
:alt: Latest Version
.. image:: https://img.shields.io/badge/License-Apache_2.0-blue.svg
:target: https://github.com/nipreps/eddymotion/blob/main/LICENSE
:alt: License
.. image:: https://readthedocs.org/projects/nireports/badge/?version=latest
:target: https://nireports.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://circleci.com/gh/nipreps/nireports/tree/main.svg?style=shield
:target: https://circleci.com/gh/nipreps/nireports/tree/main
:alt: Testing
.. image:: https://github.com/nipreps/nireports/actions/workflows/build_test_deploy.yml/badge.svg
:target: https://github.com/nipreps/nireports/actions/workflows/build_test_deploy.yml
:alt: Build-Test-Deploy
.. image:: https://codecov.io/gh/nipreps/nireports/branch/main/graph/badge.svg?token=OPH6D32GWN
:target: https://codecov.io/gh/nipreps/nireports
*NiReports*: the *NiPreps*' reporting and visualization tools
=============================================================
*NiReports* contains the two main components of the *visual reporting system* of *NiPreps*:
* **Reportlets**: visualizations for assessing the quality of a particular processing step within the neuroimaging pipeline.
Typically, reportlets show brain mosaics perhaps with contours and/or segmentations.
They can be *dynamic* and flicker between two different *states* to help assess the accuracy of image registrations.
However, the reportlets are not limited to brain mosaics, and can contain correlation plots, BOLD fMRI *carpetplots*, etc.
* **Assembler**: end-user *NiPreps* write out reportlets to a predetermined folder, which is then queried by the assembler using *PyBIDS*.
The assembler follows a *report specification* in YAML format, which states the query to find specific reportlets and their corresponding metadata and text annotations.
As a result, one HTML file with a concatenation of reportlets is produced.
Raw data
{
"_id": null,
"home_page": null,
"name": "nireports",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "The NiPreps Developers <nipreps@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d2/78/b2c38b5577db82c6651e8d990ea7afe60bbfbb75672ba25a2bae51f7b554/nireports-25.3.0.tar.gz",
"platform": null,
"description": "\n.. image:: https://img.shields.io/pypi/v/nireports.svg\n :target: https://pypi.python.org/pypi/nireports/\n :alt: Latest Version\n.. image:: https://img.shields.io/badge/License-Apache_2.0-blue.svg\n :target: https://github.com/nipreps/eddymotion/blob/main/LICENSE\n :alt: License\n.. image:: https://readthedocs.org/projects/nireports/badge/?version=latest\n :target: https://nireports.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n.. image:: https://circleci.com/gh/nipreps/nireports/tree/main.svg?style=shield\n :target: https://circleci.com/gh/nipreps/nireports/tree/main\n :alt: Testing\n.. image:: https://github.com/nipreps/nireports/actions/workflows/build_test_deploy.yml/badge.svg\n :target: https://github.com/nipreps/nireports/actions/workflows/build_test_deploy.yml\n :alt: Build-Test-Deploy\n.. image:: https://codecov.io/gh/nipreps/nireports/branch/main/graph/badge.svg?token=OPH6D32GWN\n :target: https://codecov.io/gh/nipreps/nireports\n\n*NiReports*: the *NiPreps*' reporting and visualization tools\n=============================================================\n\n*NiReports* contains the two main components of the *visual reporting system* of *NiPreps*:\n\n* **Reportlets**: visualizations for assessing the quality of a particular processing step within the neuroimaging pipeline.\n Typically, reportlets show brain mosaics perhaps with contours and/or segmentations.\n They can be *dynamic* and flicker between two different *states* to help assess the accuracy of image registrations.\n However, the reportlets are not limited to brain mosaics, and can contain correlation plots, BOLD fMRI *carpetplots*, etc.\n* **Assembler**: end-user *NiPreps* write out reportlets to a predetermined folder, which is then queried by the assembler using *PyBIDS*.\n The assembler follows a *report specification* in YAML format, which states the query to find specific reportlets and their corresponding metadata and text annotations.\n As a result, one HTML file with a concatenation of reportlets is produced.\n",
"bugtrack_url": null,
"license": null,
"summary": "NiReports - The Visual Report System (VRS) of NiPreps",
"version": "25.3.0",
"project_urls": {
"Homepage": "https://github.com/nipreps/nireports",
"NiPreps": "https://www.nipreps.org/"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4e23f87d9328c96e0107fed479ec564ce645b033ae0d6cedad2672bddeb0e065",
"md5": "5080e8fa7b84ce89535fde1cc5bc8a83",
"sha256": "2626149f718aaf9287cc2e08f4b221737ed77052a333957f0958e630ba851a2e"
},
"downloads": -1,
"filename": "nireports-25.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5080e8fa7b84ce89535fde1cc5bc8a83",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 141377,
"upload_time": "2025-09-11T01:41:42",
"upload_time_iso_8601": "2025-09-11T01:41:42.527453Z",
"url": "https://files.pythonhosted.org/packages/4e/23/f87d9328c96e0107fed479ec564ce645b033ae0d6cedad2672bddeb0e065/nireports-25.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d278b2c38b5577db82c6651e8d990ea7afe60bbfbb75672ba25a2bae51f7b554",
"md5": "85d744ae2c53149436755b2dc8583059",
"sha256": "0ac04950b3727cdc1e2740a9cb1a63aa047b24e2c7a1d945a0f852bfe753d879"
},
"downloads": -1,
"filename": "nireports-25.3.0.tar.gz",
"has_sig": false,
"md5_digest": "85d744ae2c53149436755b2dc8583059",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 77229179,
"upload_time": "2025-09-11T01:41:46",
"upload_time_iso_8601": "2025-09-11T01:41:46.015929Z",
"url": "https://files.pythonhosted.org/packages/d2/78/b2c38b5577db82c6651e8d990ea7afe60bbfbb75672ba25a2bae51f7b554/nireports-25.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-11 01:41:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nipreps",
"github_project": "nireports",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"tox": true,
"lcname": "nireports"
}