bdpy


Namebdpy JSON
Version 0.21.1 PyPI version JSON
download
home_page
SummaryBrain decoder toolbox for Python
upload_time2023-12-01 06:18:58
maintainer
docs_urlNone
author
requires_python<3.12,>=3.6
licenseMIT License Copyright (c) 2017-2023 Kamitani Lab 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 brain decoding fmri machine learning neuroimaging neuroscience
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # BdPy

[![PyPI version](https://badge.fury.io/py/bdpy.svg)](https://badge.fury.io/py/bdpy)
[![GitHub license](https://img.shields.io/github/license/KamitaniLab/bdpy)](https://github.com/KamitaniLab/bdpy/blob/master/LICENSE)
[![ci](https://github.com/KamitaniLab/bdpy/actions/workflows/ci.yml/badge.svg)](https://github.com/KamitaniLab/bdpy/actions/workflows/ci.yml)

Python package for brain decoding analysis

## Requirements

- Python 3.8 or later
- numpy
- scipy
- scikit-learn
- pandas
- h5py
- hdf5storage
- pyyaml

### Optional requirements

- `dataform` module
    - pandas
- `dl.caffe` module
    - Caffe
    - Pillow
    - tqdm
- `dl.torch` module
    - PyTorch
    - Pillow
- `fig` module
    - matplotlib
    - Pillow
- `mri` module
    - nipy
    - nibabel
    - pandas
- `recon.torch` module
    - PyTorch
    - Pillow

## Installation

Latest stable release:

``` shell
$ pip install bdpy
```

To install the latest development version ("master" branch of the repository), please run the following command.

```shell
$ pip install git+https://github.com/KamitaniLab/bdpy.git
```

## Packages

- bdata: BdPy data format (BData) core package
- dataform: Utilities for various data format
- distcomp: Distributed computation utilities
- dl: Deep learning utilities
- feature: Utilities for DNN features
- fig: Utilities for figure creation
- ml: Machine learning utilities
- mri: MRI utilities
- opendata: Open data utilities
- preproc: Utilities for preprocessing
- recon: Reconstruction methods
- stats: Utilities for statistics
- util: Miscellaneous utilities

## BdPy data format

BdPy data format (or BrainDecoderToolbox2 data format; BData) consists of two variables: dataset and metadata. **dataset** stores brain activity data (e.g., voxel signal value for fMRI data), target variables (e.g., ID of stimuli for vision experiments), and additional information specifying experimental design (e.g., run and block numbers for fMRI experiments). Each row corresponds to a single 'sample', and each column representes either single feature (voxel), target, or experiment design information. **metadata** contains data describing meta-information for each column in dataset.

See [BData API examples](https://github.com/KamitaniLab/bdpy/blob/main/docs/bdata_api_examples.md) for useage of BData.

## Developers

- Shuntaro C. Aoki (Kyoto Univ)

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "bdpy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "<3.12,>=3.6",
    "maintainer_email": "",
    "keywords": "brain decoding,fmri,machine learning,neuroimaging,neuroscience",
    "author": "",
    "author_email": "\"Shuntaro C. Aoki\" <s_aoki@i.kyoto-u.ac.jp>",
    "download_url": "https://files.pythonhosted.org/packages/b8/75/5e059142b609c7237e3ab1bbd943231a489398401233b2020545a5b17e49/bdpy-0.21.1.tar.gz",
    "platform": null,
    "description": "# BdPy\n\n[![PyPI version](https://badge.fury.io/py/bdpy.svg)](https://badge.fury.io/py/bdpy)\n[![GitHub license](https://img.shields.io/github/license/KamitaniLab/bdpy)](https://github.com/KamitaniLab/bdpy/blob/master/LICENSE)\n[![ci](https://github.com/KamitaniLab/bdpy/actions/workflows/ci.yml/badge.svg)](https://github.com/KamitaniLab/bdpy/actions/workflows/ci.yml)\n\nPython package for brain decoding analysis\n\n## Requirements\n\n- Python 3.8 or later\n- numpy\n- scipy\n- scikit-learn\n- pandas\n- h5py\n- hdf5storage\n- pyyaml\n\n### Optional requirements\n\n- `dataform` module\n    - pandas\n- `dl.caffe` module\n    - Caffe\n    - Pillow\n    - tqdm\n- `dl.torch` module\n    - PyTorch\n    - Pillow\n- `fig` module\n    - matplotlib\n    - Pillow\n- `mri` module\n    - nipy\n    - nibabel\n    - pandas\n- `recon.torch` module\n    - PyTorch\n    - Pillow\n\n## Installation\n\nLatest stable release:\n\n``` shell\n$ pip install bdpy\n```\n\nTo install the latest development version (\"master\" branch of the repository), please run the following command.\n\n```shell\n$ pip install git+https://github.com/KamitaniLab/bdpy.git\n```\n\n## Packages\n\n- bdata: BdPy data format (BData) core package\n- dataform: Utilities for various data format\n- distcomp: Distributed computation utilities\n- dl: Deep learning utilities\n- feature: Utilities for DNN features\n- fig: Utilities for figure creation\n- ml: Machine learning utilities\n- mri: MRI utilities\n- opendata: Open data utilities\n- preproc: Utilities for preprocessing\n- recon: Reconstruction methods\n- stats: Utilities for statistics\n- util: Miscellaneous utilities\n\n## BdPy data format\n\nBdPy data format (or BrainDecoderToolbox2 data format; BData) consists of two variables: dataset and metadata. **dataset** stores brain activity data (e.g., voxel signal value for fMRI data), target variables (e.g., ID of stimuli for vision experiments), and additional information specifying experimental design (e.g., run and block numbers for fMRI experiments). Each row corresponds to a single 'sample', and each column representes either single feature (voxel), target, or experiment design information. **metadata** contains data describing meta-information for each column in dataset.\n\nSee [BData API examples](https://github.com/KamitaniLab/bdpy/blob/main/docs/bdata_api_examples.md) for useage of BData.\n\n## Developers\n\n- Shuntaro C. Aoki (Kyoto Univ)\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2017-2023 Kamitani Lab  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": "Brain decoder toolbox for Python",
    "version": "0.21.1",
    "project_urls": {
        "Bug Tracker": "https://github.com/KamitaniLab/bdpy/issues",
        "Homepage": "https://github.com/KamitaniLab/bdpy",
        "Repository": "https://github.com/KamitaniLab/bdpy"
    },
    "split_keywords": [
        "brain decoding",
        "fmri",
        "machine learning",
        "neuroimaging",
        "neuroscience"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fd5ad84610b9986478bacdef32a0095e89e5759157d1db052a3fb68dd05d956c",
                "md5": "9568b75a7041b7b16cadbdc6406ecd15",
                "sha256": "cc67eec79bdf571851b64f45de4e1ee50d15eaa21d0b4ba3771f46a80641fb93"
            },
            "downloads": -1,
            "filename": "bdpy-0.21.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9568b75a7041b7b16cadbdc6406ecd15",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.6",
            "size": 100939,
            "upload_time": "2023-12-01T06:18:55",
            "upload_time_iso_8601": "2023-12-01T06:18:55.397472Z",
            "url": "https://files.pythonhosted.org/packages/fd/5a/d84610b9986478bacdef32a0095e89e5759157d1db052a3fb68dd05d956c/bdpy-0.21.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b8755e059142b609c7237e3ab1bbd943231a489398401233b2020545a5b17e49",
                "md5": "417c0ac86168ca90b625c9885b195cc3",
                "sha256": "0d5b07ab1bb47bd10f4f2104386530f44c27b62f7b8540e3aa06d28020ca65ea"
            },
            "downloads": -1,
            "filename": "bdpy-0.21.1.tar.gz",
            "has_sig": false,
            "md5_digest": "417c0ac86168ca90b625c9885b195cc3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.6",
            "size": 80292,
            "upload_time": "2023-12-01T06:18:58",
            "upload_time_iso_8601": "2023-12-01T06:18:58.190504Z",
            "url": "https://files.pythonhosted.org/packages/b8/75/5e059142b609c7237e3ab1bbd943231a489398401233b2020545a5b17e49/bdpy-0.21.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-01 06:18:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "KamitaniLab",
    "github_project": "bdpy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "bdpy"
}
        
Elapsed time: 0.14740s