nwb2bids


Namenwb2bids JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryReorganize NWB files into a BIDS directory layout.
upload_time2025-07-11 19:24:21
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2025 nwb2bids 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 bids brain imaging data structure dandi archive nwb neurodatawithoutborders data organization data standards neurodata neuroscience
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <h1 align="center">nwb2bids</h3>
  <p align="center">
    <a href="https://pypi.org/project/nwb2bids/"><img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/nwb2bids.svg"></a>
    <a href="https://codecov.io/github/con/nwb2bids?branch=main"><img alt="codecov" src="https://codecov.io/github/con/nwb2bids/coverage.svg?branch=main"></a>
  </p>
  <p align="center">
    <a href="https://pypi.org/project/nwb2bids/"><img alt="PyPI latest release version" src="https://badge.fury.io/py/nwb2bids.svg?id=py&kill_cache=1"></a>
    <a href="https://github.com/con/nwb2bids/blob/main/LICENSE.txt"><img alt="License: BSD-3" src="https://img.shields.io/pypi/l/nwb2bids.svg"></a>
  </p>
  <p align="center">
    <a href="https://github.com/psf/black"><img alt="Python code style: Black" src="https://img.shields.io/badge/python_code_style-black-000000.svg"></a>
    <a href="https://github.com/astral-sh/ruff"><img alt="Python code style: Ruff" src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"></a>
  </p>
</p>

# nwb2bids

Reorganize NWB files into a BIDS directory layout.

Currently developed for the `microephys` BIDS modality, which encompasses both the NWB `ecephys` and `icephys` neurodata subtypes, and which is currently pending formal inclusion in BIDS schema as part of [BEP032](https://github.com/bids-standard/bids-specification/pull/1705).

# Usage

The package ships the `nwb2bids` CLI command.

```bash
nwb2bids < directory of NWB files > < BIDS organized directory >
```

For example:

```bash
nwb2bids /mnt/my_existing_nwbfiles/ /mnt/my_new_bids_dataset/
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nwb2bids",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "BIDS, Brain Imaging Data Structure, DANDI Archive, NWB, NeurodataWithoutBorders, data organization, data standards, neurodata, neuroscience",
    "author": null,
    "author_email": "Cody Baker <cody.c.baker.phd@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/9e/15/faaadab23896128ffbf28757fd1015a318eeb6ab69d9005ea1a3e7bbae20/nwb2bids-0.2.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <h1 align=\"center\">nwb2bids</h3>\n  <p align=\"center\">\n    <a href=\"https://pypi.org/project/nwb2bids/\"><img alt=\"Supported Python versions\" src=\"https://img.shields.io/pypi/pyversions/nwb2bids.svg\"></a>\n    <a href=\"https://codecov.io/github/con/nwb2bids?branch=main\"><img alt=\"codecov\" src=\"https://codecov.io/github/con/nwb2bids/coverage.svg?branch=main\"></a>\n  </p>\n  <p align=\"center\">\n    <a href=\"https://pypi.org/project/nwb2bids/\"><img alt=\"PyPI latest release version\" src=\"https://badge.fury.io/py/nwb2bids.svg?id=py&kill_cache=1\"></a>\n    <a href=\"https://github.com/con/nwb2bids/blob/main/LICENSE.txt\"><img alt=\"License: BSD-3\" src=\"https://img.shields.io/pypi/l/nwb2bids.svg\"></a>\n  </p>\n  <p align=\"center\">\n    <a href=\"https://github.com/psf/black\"><img alt=\"Python code style: Black\" src=\"https://img.shields.io/badge/python_code_style-black-000000.svg\"></a>\n    <a href=\"https://github.com/astral-sh/ruff\"><img alt=\"Python code style: Ruff\" src=\"https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\"></a>\n  </p>\n</p>\n\n# nwb2bids\n\nReorganize NWB files into a BIDS directory layout.\n\nCurrently developed for the `microephys` BIDS modality, which encompasses both the NWB `ecephys` and `icephys` neurodata subtypes, and which is currently pending formal inclusion in BIDS schema as part of [BEP032](https://github.com/bids-standard/bids-specification/pull/1705).\n\n# Usage\n\nThe package ships the `nwb2bids` CLI command.\n\n```bash\nnwb2bids < directory of NWB files > < BIDS organized directory >\n```\n\nFor example:\n\n```bash\nnwb2bids /mnt/my_existing_nwbfiles/ /mnt/my_new_bids_dataset/\n```\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 nwb2bids\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "Reorganize NWB files into a BIDS directory layout.",
    "version": "0.2.0",
    "project_urls": {
        "Changelog": "https://github.com/con/nwb2bids/blob/master/CHANGELOG.md",
        "Issues": "https://github.com/con/nwb2bids/issues",
        "Repository": "https://github.com/con/nwb2bids/"
    },
    "split_keywords": [
        "bids",
        " brain imaging data structure",
        " dandi archive",
        " nwb",
        " neurodatawithoutborders",
        " data organization",
        " data standards",
        " neurodata",
        " neuroscience"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3873b46f2824bff457dc08cef671288723d3d46badf239b378327bc4efa1528b",
                "md5": "ca2ecb14c413db92b1435325ed7a1bac",
                "sha256": "7bb934eacd906f8966eb85b78bff41fbf21e9efb0580371e238c00275dcc02d8"
            },
            "downloads": -1,
            "filename": "nwb2bids-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ca2ecb14c413db92b1435325ed7a1bac",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 24980,
            "upload_time": "2025-07-11T19:24:20",
            "upload_time_iso_8601": "2025-07-11T19:24:20.079112Z",
            "url": "https://files.pythonhosted.org/packages/38/73/b46f2824bff457dc08cef671288723d3d46badf239b378327bc4efa1528b/nwb2bids-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9e15faaadab23896128ffbf28757fd1015a318eeb6ab69d9005ea1a3e7bbae20",
                "md5": "74bfe9545a13f36c8087434d0df9552f",
                "sha256": "a60598b852bf385ad0bdfb0e5b337ffce51a39ccede33c41543053c0071f3f23"
            },
            "downloads": -1,
            "filename": "nwb2bids-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "74bfe9545a13f36c8087434d0df9552f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 21477,
            "upload_time": "2025-07-11T19:24:21",
            "upload_time_iso_8601": "2025-07-11T19:24:21.153582Z",
            "url": "https://files.pythonhosted.org/packages/9e/15/faaadab23896128ffbf28757fd1015a318eeb6ab69d9005ea1a3e7bbae20/nwb2bids-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-11 19:24:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "con",
    "github_project": "nwb2bids",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "nwb2bids"
}
        
Elapsed time: 0.95050s