surfplot


Namesurfplot JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://surfplot.readthedocs.io/en/latest/
SummaryA package for publication-ready brain surface figures
upload_time2022-12-20 18:51:23
maintainer
docs_urlNone
authorDan Gale
requires_python>=3.7.0
licenseBSD-3
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            surfplot
========

.. image:: https://zenodo.org/badge/380025008.svg
   :target: https://zenodo.org/badge/latestdoi/380025008

``surfplot`` is a flexible and easy-to-use package that makes publication-ready brain surface plots. Users can easily set the plot views and layout, add multiple data layers, draw outlines, and further customize their figure directly using matplotlib. 

.. figure:: https://raw.githubusercontent.com/danjgale/surfplot/main/docs/auto_examples/examples/images/sphx_glr_plot_example_01_001.png
	:target: https://surfplot.readthedocs.io/en/latest/auto_examples/examples/plot_example_01.html#sphx-glr-auto-examples-examples-plot-example-01-py
	:alt: example
	:align: center
	
	Example Neurosynth association maps; see `Example 1`_

At its core, ``surfplot`` is simply a high-level interface to `Brainspace's <https://brainspace.readthedocs.io/en/latest/index.html>`_ excellent surface `plotting <https://brainspace.readthedocs.io/en/latest/python_doc/api_doc/brainspace.plotting.html>`_ and `manipulation <https://brainspace.readthedocs.io/en/latest/python_doc/api_doc/brainspace.mesh.html>`_ capabilities, which are built on top of `Visualization Toolkit (VTK) <https://vtk.org/>`_. Surfaces are rendered with Brainspace and then embedded into a matplotlib figure for easy integration with typical plotting workflows. A big thank you to the ``Brainspace`` developers for making this package possible. 

``surfplot`` is designed around common use-cases for surface plotting and popular surface plotting software (e.g., `Connectome Workbench <https://www.humanconnectome.org/software/connectome-workbench>`_). ``surfplot`` also provides some additional utility functions to streamline the plotting process.

Getting started
---------------

Follow the `Installation Instructions`_ to install ``surfplot``, and then check out the `Tutorials and Examples`_ to learn how to get up and running! Refer to the `API reference`_ for complete documentation. 

Citing surfplot
---------------

Please cite the following if you use ``surfplot``:

Gale, Daniel J., Vos de Wael., Reinder, Benkarim, Oualid, & Bernhardt, Boris. (2021). Surfplot: Publication-ready brain surface figures (v0.1.0). Zenodo. https://doi.org/10.5281/zenodo.5567926

Vos de Wael R, Benkarim O, Paquola C, Lariviere S, Royer J, Tavakol S, Xu T, Hong S-J, Langs G, Valk S, Misic B, Milham M, Margulies D, Smallwood J, Bernhardt BC. 2020. BrainSpace: a toolbox for the analysis of macroscale gradients in neuroimaging and connectomics datasets. *Communications Biology*. 3:103. https://doi.org/10.1038/s42003-020-0794-7

License information
-------------------

This codebase is licensed under the `3-clause BSD license <https://opensource.org/licenses/BSD-3-Clause>`_. The full license can be found in the `LICENSE <https://github.com/danjgale/surfplot/blob/main/LICENSE>`_ file in the ``surfplot`` distribution.

Support
-------

If you encounter problems or bugs with ``surfplot``, or have questions or improvement suggestions, please feel free to get in touch via the `Github issues <https://github.com/danjgale/surfplot/issues>`_.

.. _Example 1: https://surfplot.readthedocs.io/en/latest/auto_examples/examples/plot_example_01.html#sphx-glr-auto-examples-examples-plot-example-01-py
.. _Installation Instructions: https://surfplot.readthedocs.io/en/latest/installation.html
.. _Tutorials and Examples: https://surfplot.readthedocs.io/en/latest/auto_examples/index.html
.. _API reference: https://surfplot.readthedocs.io/en/latest/api.html

            

Raw data

            {
    "_id": null,
    "home_page": "https://surfplot.readthedocs.io/en/latest/",
    "name": "surfplot",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7.0",
    "maintainer_email": "d.gale@queensu.ca",
    "keywords": "",
    "author": "Dan Gale",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/d4/f8/1b74ddcb05764db182b1f468bcb8efb5548b8efe5f6e29be86c07d25cd8e/surfplot-0.2.0.tar.gz",
    "platform": null,
    "description": "surfplot\n========\n\n.. image:: https://zenodo.org/badge/380025008.svg\n   :target: https://zenodo.org/badge/latestdoi/380025008\n\n``surfplot`` is a flexible and easy-to-use package that makes publication-ready brain surface plots. Users can easily set the plot views and layout, add multiple data layers, draw outlines, and further customize their figure directly using matplotlib. \n\n.. figure:: https://raw.githubusercontent.com/danjgale/surfplot/main/docs/auto_examples/examples/images/sphx_glr_plot_example_01_001.png\n\t:target: https://surfplot.readthedocs.io/en/latest/auto_examples/examples/plot_example_01.html#sphx-glr-auto-examples-examples-plot-example-01-py\n\t:alt: example\n\t:align: center\n\t\n\tExample Neurosynth association maps; see `Example 1`_\n\nAt its core, ``surfplot`` is simply a high-level interface to `Brainspace's <https://brainspace.readthedocs.io/en/latest/index.html>`_ excellent surface `plotting <https://brainspace.readthedocs.io/en/latest/python_doc/api_doc/brainspace.plotting.html>`_ and `manipulation <https://brainspace.readthedocs.io/en/latest/python_doc/api_doc/brainspace.mesh.html>`_ capabilities, which are built on top of `Visualization Toolkit (VTK) <https://vtk.org/>`_. Surfaces are rendered with Brainspace and then embedded into a matplotlib figure for easy integration with typical plotting workflows. A big thank you to the ``Brainspace`` developers for making this package possible. \n\n``surfplot`` is designed around common use-cases for surface plotting and popular surface plotting software (e.g., `Connectome Workbench <https://www.humanconnectome.org/software/connectome-workbench>`_). ``surfplot`` also provides some additional utility functions to streamline the plotting process.\n\nGetting started\n---------------\n\nFollow the `Installation Instructions`_ to install ``surfplot``, and then check out the `Tutorials and Examples`_ to learn how to get up and running! Refer to the `API reference`_ for complete documentation. \n\nCiting surfplot\n---------------\n\nPlease cite the following if you use ``surfplot``:\n\nGale, Daniel J., Vos de Wael., Reinder, Benkarim, Oualid, & Bernhardt, Boris. (2021). Surfplot: Publication-ready brain surface figures (v0.1.0). Zenodo. https://doi.org/10.5281/zenodo.5567926\n\nVos de Wael R, Benkarim O, Paquola C, Lariviere S, Royer J, Tavakol S, Xu T, Hong S-J, Langs G, Valk S, Misic B, Milham M, Margulies D, Smallwood J, Bernhardt BC. 2020. BrainSpace: a toolbox for the analysis of macroscale gradients in neuroimaging and connectomics datasets. *Communications Biology*. 3:103. https://doi.org/10.1038/s42003-020-0794-7\n\nLicense information\n-------------------\n\nThis codebase is licensed under the `3-clause BSD license <https://opensource.org/licenses/BSD-3-Clause>`_. The full license can be found in the `LICENSE <https://github.com/danjgale/surfplot/blob/main/LICENSE>`_ file in the ``surfplot`` distribution.\n\nSupport\n-------\n\nIf you encounter problems or bugs with ``surfplot``, or have questions or improvement suggestions, please feel free to get in touch via the `Github issues <https://github.com/danjgale/surfplot/issues>`_.\n\n.. _Example 1: https://surfplot.readthedocs.io/en/latest/auto_examples/examples/plot_example_01.html#sphx-glr-auto-examples-examples-plot-example-01-py\n.. _Installation Instructions: https://surfplot.readthedocs.io/en/latest/installation.html\n.. _Tutorials and Examples: https://surfplot.readthedocs.io/en/latest/auto_examples/index.html\n.. _API reference: https://surfplot.readthedocs.io/en/latest/api.html\n",
    "bugtrack_url": null,
    "license": "BSD-3",
    "summary": "A package for publication-ready brain surface figures",
    "version": "0.2.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "db97b3d6490253adb7077137470634b9",
                "sha256": "cec0cc4283406898ef0c92e7c952dddc0f77993a8c05a6ceb9974a556a228ab8"
            },
            "downloads": -1,
            "filename": "surfplot-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db97b3d6490253adb7077137470634b9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.0",
            "size": 69762,
            "upload_time": "2022-12-20T18:51:21",
            "upload_time_iso_8601": "2022-12-20T18:51:21.260654Z",
            "url": "https://files.pythonhosted.org/packages/b1/17/440347ae24a38c78a9b116e0b80d91ee980ab88936a474546b7d2b5238c9/surfplot-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "4fa2cc81d4b24a94bd33565b62968929",
                "sha256": "1dd4ae3943860b1756f97e6acb10decc6e0411637a9d3ab4d365c4df99bb7bad"
            },
            "downloads": -1,
            "filename": "surfplot-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4fa2cc81d4b24a94bd33565b62968929",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.0",
            "size": 72066,
            "upload_time": "2022-12-20T18:51:23",
            "upload_time_iso_8601": "2022-12-20T18:51:23.229562Z",
            "url": "https://files.pythonhosted.org/packages/d4/f8/1b74ddcb05764db182b1f468bcb8efb5548b8efe5f6e29be86c07d25cd8e/surfplot-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-20 18:51:23",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "surfplot"
}
        
Elapsed time: 0.02541s