# brainsurfy
Simple surface plots in Python based on ggseg parcellations.
```
import matplotlib.pyplot as plt
from brainsurfy import fetch_atlas_data, simulate_data, plot_surf
atlas_data = fetch_atlas_data('schaefer7_400')
sim_data = simulate_data(atlas_data)
plot_surf(atlas_data, sim_data, cmap=plt.cm.viridis, cbar=True)
```
Output:
## Installation
brainsurfy is meant to be used with Python 3.9 or above, and has been tested on Python 3.9-3.12.
#### Dependencies
- [NumPy](https://numpy.org/)
- [Pandas](https://pandas.pydata.org/)
- [matplotlib](https://matplotlib.org/)
- [seaborn](https://seaborn.pydata.org/)
#### User installation
To install brainsurfy, run this command in your terminal:
`pip install brainsurfy`
This is the preferred method to install brainsurfy, as it will always install the most recent stable release.
If you don’t have [pip](https://pip.pypa.io/) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.
## to-do:
- a lot of things...
- look into 3d surface plots
- docs (once there is more stuff)
- form into package and upload to pypi
=======
History
=======
0.0.1 (2024-03-15)
------------------
* First release on PyPI.
0.0.2 (2024-03-15)
------------------
* Fix fetching atlases function.
0.0.3 (2024-03-15)
------------------
* More fixes including actually including the atlases folder (dumb mistake...)
Raw data
{
"_id": null,
"home_page": "https://github.com/teanijarv/brainsurfy",
"name": "brainsurfy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "brainsurfy",
"author": "Toomas Erik Anij\u00e4rv",
"author_email": "toomaserikanijarv@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/61/0f/8b574f0ecea5cc14bdfc4d0afd60c4ee0fcbe530ed1866eee94c35b9021f/brainsurfy-0.0.3.tar.gz",
"platform": null,
"description": "# brainsurfy\n\nSimple surface plots in Python based on ggseg parcellations.\n\n```\nimport matplotlib.pyplot as plt\n\nfrom brainsurfy import fetch_atlas_data, simulate_data, plot_surf\n\natlas_data = fetch_atlas_data('schaefer7_400')\nsim_data = simulate_data(atlas_data)\n\nplot_surf(atlas_data, sim_data, cmap=plt.cm.viridis, cbar=True)\n```\n\nOutput:\n\n\n\n## Installation\nbrainsurfy is meant to be used with Python 3.9 or above, and has been tested on Python 3.9-3.12.\n\n#### Dependencies\n- [NumPy](https://numpy.org/)\n- [Pandas](https://pandas.pydata.org/)\n- [matplotlib](https://matplotlib.org/)\n- [seaborn](https://seaborn.pydata.org/)\n\n#### User installation\nTo install brainsurfy, run this command in your terminal:\n\n`pip install brainsurfy`\n\nThis is the preferred method to install brainsurfy, as it will always install the most recent stable release.\n\nIf you don\u2019t have [pip](https://pip.pypa.io/) installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process.\n\n## to-do:\n- a lot of things...\n- look into 3d surface plots\n- docs (once there is more stuff)\n- form into package and upload to pypi\n\n=======\nHistory\n=======\n\n0.0.1 (2024-03-15)\n------------------\n\n* First release on PyPI.\n\n0.0.2 (2024-03-15)\n------------------\n\n* Fix fetching atlases function.\n\n0.0.3 (2024-03-15)\n------------------\n\n* More fixes including actually including the atlases folder (dumb mistake...)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "brainsurfy",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/teanijarv/brainsurfy"
},
"split_keywords": [
"brainsurfy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f1fbee128bb15b78b32814b611d77735207d2f4834a39f2a3b873329a8435d16",
"md5": "2525d666d83d31d23fba72c6460de18c",
"sha256": "702df6dde14f74601fae86052881a0a4f7ad321e4d89b347f7f281624e60dce5"
},
"downloads": -1,
"filename": "brainsurfy-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2525d666d83d31d23fba72c6460de18c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 78549,
"upload_time": "2024-03-15T11:06:26",
"upload_time_iso_8601": "2024-03-15T11:06:26.128921Z",
"url": "https://files.pythonhosted.org/packages/f1/fb/ee128bb15b78b32814b611d77735207d2f4834a39f2a3b873329a8435d16/brainsurfy-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "610f8b574f0ecea5cc14bdfc4d0afd60c4ee0fcbe530ed1866eee94c35b9021f",
"md5": "82c4a106850003510d2f26a60df40d0b",
"sha256": "402f263adcbe451fc15fb12d254bbbcc31160bd41aa242143dc9395f12c25787"
},
"downloads": -1,
"filename": "brainsurfy-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "82c4a106850003510d2f26a60df40d0b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 78746,
"upload_time": "2024-03-15T11:06:27",
"upload_time_iso_8601": "2024-03-15T11:06:27.801893Z",
"url": "https://files.pythonhosted.org/packages/61/0f/8b574f0ecea5cc14bdfc4d0afd60c4ee0fcbe530ed1866eee94c35b9021f/brainsurfy-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-15 11:06:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "teanijarv",
"github_project": "brainsurfy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
"==",
"1.26.4"
]
]
},
{
"name": "pandas",
"specs": [
[
"==",
"2.2.1"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"==",
"3.8.3"
]
]
},
{
"name": "seaborn",
"specs": [
[
"==",
"0.13.2"
]
]
}
],
"lcname": "brainsurfy"
}
JSON
