# WebGL-based 3D Brain for Python
The project is part of [YAEL](https://yael.wiki/).
[](https://dipterix.org/threeBrainPy/showcase-viewer/)
## Installation
### Install from `pypi`:
```sh
# Bare minimal
pip install threebrainpy
```
### Install from `Github`:
```sh
pip install pandas matplotlib
pip install git+https://github.com/dipterix/threebrainpy
```
### Test the installation
Launch Python with your favorite editor, run the following Python commands. If you don't have `FreeSurfer` installed, replace `path` with any fs subject. If you don't have any, go to [sample templates](https://github.com/dipterix/threeBrain-sample/releases) and download one.
```python
import os
from threebrainpy.core import Brain
# You can replace `path` with any FreeSurfer-generated subject folder
path = os.path.join(os.environ["FREESURFER_HOME"], "subjects", "fsaverage")
brain = Brain(os.path.basename(path), path)
brain.add_slice("brain")
brain.add_slice("brain.finalsurf")
brain.add_surfaces("pial")
brain.render()
```
## Documentation
Please check the documentation [here](https://dipterix.org/threeBrainPy/).
## Other implementations
This Python package implements the core functionalities. More advanced features will come soon.
The core script is written in [JavaScript](https://github.com/dipterix/three-brain-js). The R implementation [threeBrain](https://github.com/dipterix/threeBrain) is available on [CRAN](https://cran.r-project.org/package=threeBrain).
Here is a comparison of the Python vs R packages:
| Feature | R | Python |
|---------|--------|---|
| 3D Brain | :white_check_mark: | :white_check_mark: |
| 3D Electrodes | :white_check_mark: | :white_check_mark: |
| Electrode Localization | :white_check_mark: | :heart: |
| Dashboard Integration | :white_check_mark: | :heart: |
* :white_check_mark: = implemented
* :heart: = will implement if I get enough requests or I get grants to do so
# Sponsor
We are actively looking for grant fundings. It is super hard for software projects to apply for fundings. Your support will be greatly appreciated. Please email `help` at `rave.wiki` to join our slack channel if you want to:
* Request a demos
* Ask questions
* Use our software
* Collaborate with us
Raw data
{
"_id": null,
"home_page": "https://github.com/dipterix/threeBrainPy",
"name": "threebrainpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "iEEG, DBS, Visualization, Neuroscience, Electrophysiology, Electrode, Localizer",
"author": "Zhengjia Wang",
"author_email": "dipterix.wang@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/70/b6/8f1e7ee2a49f7c2ac393e97e5c71d0279b457a60b8a20672caf216c88e0d/threebrainpy-0.1.2.tar.gz",
"platform": null,
"description": "# WebGL-based 3D Brain for Python\n\nThe project is part of [YAEL](https://yael.wiki/). \n\n[](https://dipterix.org/threeBrainPy/showcase-viewer/)\n\n## Installation\n\n### Install from `pypi`:\n\n```sh\n# Bare minimal\npip install threebrainpy\n```\n\n\n### Install from `Github`:\n\n```sh\npip install pandas matplotlib\npip install git+https://github.com/dipterix/threebrainpy\n```\n\n### Test the installation\n\nLaunch Python with your favorite editor, run the following Python commands. If you don't have `FreeSurfer` installed, replace `path` with any fs subject. If you don't have any, go to [sample templates](https://github.com/dipterix/threeBrain-sample/releases) and download one.\n\n```python\nimport os\nfrom threebrainpy.core import Brain\n\n# You can replace `path` with any FreeSurfer-generated subject folder\npath = os.path.join(os.environ[\"FREESURFER_HOME\"], \"subjects\", \"fsaverage\")\n\nbrain = Brain(os.path.basename(path), path)\nbrain.add_slice(\"brain\")\nbrain.add_slice(\"brain.finalsurf\")\nbrain.add_surfaces(\"pial\")\nbrain.render()\n```\n\n## Documentation\n\nPlease check the documentation [here](https://dipterix.org/threeBrainPy/).\n\n\n## Other implementations\n\nThis Python package implements the core functionalities. More advanced features will come soon. \n\nThe core script is written in [JavaScript](https://github.com/dipterix/three-brain-js). The R implementation [threeBrain](https://github.com/dipterix/threeBrain) is available on [CRAN](https://cran.r-project.org/package=threeBrain).\n\nHere is a comparison of the Python vs R packages:\n\n| Feature | R | Python |\n|---------|--------|---|\n| 3D Brain | :white_check_mark: | :white_check_mark: |\n| 3D Electrodes | :white_check_mark: | :white_check_mark: |\n| Electrode Localization | :white_check_mark: | :heart: |\n| Dashboard Integration | :white_check_mark: | :heart: |\n\n* :white_check_mark: = implemented\n* :heart: = will implement if I get enough requests or I get grants to do so\n\n# Sponsor\n\nWe are actively looking for grant fundings. It is super hard for software projects to apply for fundings. Your support will be greatly appreciated. Please email `help` at `rave.wiki` to join our slack channel if you want to:\n\n* Request a demos\n* Ask questions\n* Use our software\n* Collaborate with us\n\n\n",
"bugtrack_url": null,
"license": "Mozilla Public License 2.0 (MPL 2.0)",
"summary": "Your Advanced Brain Viewer for Python",
"version": "0.1.2",
"project_urls": {
"Bug Reports": "https://github.com/dipterix/threeBrainPy/issues",
"Homepage": "https://github.com/dipterix/threeBrainPy",
"Project Website": "https://yael.wiki/",
"Source": "https://github.com/dipterix/threeBrainPy/"
},
"split_keywords": [
"ieeg",
" dbs",
" visualization",
" neuroscience",
" electrophysiology",
" electrode",
" localizer"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d21359818f99d4fda315a84945732b169202f62c7f9cf5bfe18bee1acf074710",
"md5": "ef67c59784ff69df2abf7596167dafec",
"sha256": "8f59bd3e082c92743aee610e7eabefd481f7210f947a09eb505fdb7aa493787d"
},
"downloads": -1,
"filename": "threebrainpy-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef67c59784ff69df2abf7596167dafec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 3736008,
"upload_time": "2025-01-29T10:00:17",
"upload_time_iso_8601": "2025-01-29T10:00:17.185590Z",
"url": "https://files.pythonhosted.org/packages/d2/13/59818f99d4fda315a84945732b169202f62c7f9cf5bfe18bee1acf074710/threebrainpy-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "70b68f1e7ee2a49f7c2ac393e97e5c71d0279b457a60b8a20672caf216c88e0d",
"md5": "9c50c139c636eaa317fd8b0790943ea3",
"sha256": "b66dbe5d8119d0ad89ae44c857c97b00d9d73e5536983621ecae1051aac7e830"
},
"downloads": -1,
"filename": "threebrainpy-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "9c50c139c636eaa317fd8b0790943ea3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 3695788,
"upload_time": "2025-01-29T10:00:21",
"upload_time_iso_8601": "2025-01-29T10:00:21.981697Z",
"url": "https://files.pythonhosted.org/packages/70/b6/8f1e7ee2a49f7c2ac393e97e5c71d0279b457a60b8a20672caf216c88e0d/threebrainpy-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-29 10:00:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dipterix",
"github_project": "threeBrainPy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "matplotlib",
"specs": [
[
">=",
"3.7.2"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.25.2"
]
]
},
{
"name": "pandas",
"specs": [
[
">=",
"2.0.3"
]
]
},
{
"name": "nibabel",
"specs": [
[
">=",
"5.1.0"
]
]
}
],
"lcname": "threebrainpy"
}
JSON
