Metadata-Version: 2.2
Name: threebrainpy
Version: 0.1.2
Summary: Your Advanced Brain Viewer for Python
Home-page: https://github.com/dipterix/threeBrainPy
Author: Zhengjia Wang
Author-email: dipterix.wang@gmail.com
License: Mozilla Public License 2.0 (MPL 2.0)
Project-URL: Project Website, https://yael.wiki/
Project-URL: Source, https://github.com/dipterix/threeBrainPy/
Project-URL: Bug Reports, https://github.com/dipterix/threeBrainPy/issues
Keywords: iEEG,DBS,Visualization,Neuroscience,Electrophysiology,Electrode,Localizer
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Multimedia :: Graphics :: 3D Rendering
Classifier: Topic :: Scientific/Engineering :: Human Machine Interfaces
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: nibabel
Requires-Dist: pandas
Requires-Dist: matplotlib
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# WebGL-based 3D Brain for Python

The project is part of [YAEL](https://yael.wiki/). 

[![Check out live demo](docs/assets/images/showcase-01.png)](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


