neuroglancer-scripts
====================
Tools for converting volumetric images and surface meshes to the pre-computed format of Neuroglancer_.
.. image:: https://img.shields.io/pypi/v/neuroglancer-scripts.svg
:target: https://pypi.python.org/pypi/neuroglancer-scripts
:alt: PyPI Version
.. image:: https://github.com/HumanBrainProject/neuroglancer-scripts/actions/workflows/tox.yaml/badge.svg
:target: https://github.com/HumanBrainProject/neuroglancer-scripts/actions/workflows/tox.yaml
:alt: Build Status
.. image:: https://codecov.io/gh/HumanBrainProject/neuroglancer-scripts/branch/master/graph/badge.svg
:target: https://codecov.io/gh/HumanBrainProject/neuroglancer-scripts
:alt: Coverage Status
.. image:: https://readthedocs.org/projects/neuroglancer-scripts/badge/?version=latest
:target: http://neuroglancer-scripts.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Installation
------------
The easiest way to install the latest stable version of neuroglancer-scripts is
through ``pip``. Using a virtual environment is recommended:
.. code-block:: shell
python3 -m venv venv/
. venv/bin/activate
pip install neuroglancer-scripts
Usage
-----
See the `documentation <http://neuroglancer-scripts.readthedocs.io/>`_.
Development
-----------
The code is hosted on https://github.com/HumanBrainProject/neuroglancer-scripts.
Useful commands for development:
.. code-block:: shell
git clone https://github.com/HumanBrainProject/neuroglancer-scripts.git
# Install in a virtual environment
cd neuroglancer-scripts
python3 -m venv venv/
. venv/bin/activate
pip install -e .[dev]
# Tests
pytest # run tests
pytest --cov=neuroglancer_scripts --cov-report=html # detailed test coverage report
tox # run tests under all supported Python versions
# Please install pre-commit if you intend to contribute
pre-commit install # install the pre-commit hook
Contributing
============
This repository uses `pre-commit`_ to ensure that all committed code follows minimal quality standards. Please install it and configure it to run as a pre-commit hook in your local repository (see above).
.. _Neuroglancer: https://github.com/google/neuroglancer
.. _pre-commit: https://pre-commit.com/
Raw data
{
"_id": null,
"home_page": "https://github.com/HumanBrainProject/neuroglancer-scripts",
"name": "neuroglancer-scripts",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.5",
"maintainer_email": "",
"keywords": "neuroimaging",
"author": "Yann Leprince",
"author_email": "yann.leprince@cea.fr",
"download_url": "https://files.pythonhosted.org/packages/d0/2e/2718b3919ea0e5838fe9e87445bece153ed9aa6e517c8047464a6c3ce453/neuroglancer-scripts-1.0.0.tar.gz",
"platform": "",
"description": "neuroglancer-scripts\n====================\n\nTools for converting volumetric images and surface meshes to the pre-computed format of Neuroglancer_.\n\n\n.. image:: https://img.shields.io/pypi/v/neuroglancer-scripts.svg\n :target: https://pypi.python.org/pypi/neuroglancer-scripts\n :alt: PyPI Version\n\n.. image:: https://github.com/HumanBrainProject/neuroglancer-scripts/actions/workflows/tox.yaml/badge.svg\n :target: https://github.com/HumanBrainProject/neuroglancer-scripts/actions/workflows/tox.yaml\n :alt: Build Status\n\n.. image:: https://codecov.io/gh/HumanBrainProject/neuroglancer-scripts/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/HumanBrainProject/neuroglancer-scripts\n :alt: Coverage Status\n\n.. image:: https://readthedocs.org/projects/neuroglancer-scripts/badge/?version=latest\n :target: http://neuroglancer-scripts.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n\nInstallation\n------------\n\nThe easiest way to install the latest stable version of neuroglancer-scripts is\nthrough ``pip``. Using a virtual environment is recommended:\n\n.. code-block:: shell\n\n python3 -m venv venv/\n . venv/bin/activate\n pip install neuroglancer-scripts\n\n\nUsage\n-----\n\nSee the `documentation <http://neuroglancer-scripts.readthedocs.io/>`_.\n\n\nDevelopment\n-----------\n\nThe code is hosted on https://github.com/HumanBrainProject/neuroglancer-scripts.\n\nUseful commands for development:\n\n.. code-block:: shell\n\n git clone https://github.com/HumanBrainProject/neuroglancer-scripts.git\n\n # Install in a virtual environment\n cd neuroglancer-scripts\n python3 -m venv venv/\n . venv/bin/activate\n pip install -e .[dev]\n\n # Tests\n pytest # run tests\n pytest --cov=neuroglancer_scripts --cov-report=html # detailed test coverage report\n tox # run tests under all supported Python versions\n\n # Please install pre-commit if you intend to contribute\n pre-commit install # install the pre-commit hook\n\n\nContributing\n============\n\nThis repository uses `pre-commit`_ to ensure that all committed code follows minimal quality standards. Please install it and configure it to run as a pre-commit hook in your local repository (see above).\n\n\n.. _Neuroglancer: https://github.com/google/neuroglancer\n.. _pre-commit: https://pre-commit.com/\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Conversion of images to the Neuroglancer pre-computed format",
"version": "1.0.0",
"split_keywords": [
"neuroimaging"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1081ff637ea78b1d38eb50029d19a4dcb9c5eb037befeefdd44dca760d831b88",
"md5": "be940cc8f2dee7cba4ab4f55cd6d809b",
"sha256": "b29aa369309aebe527579030fa5696ce92a3ea2df173576a38dd9c08704fd23a"
},
"downloads": -1,
"filename": "neuroglancer_scripts-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be940cc8f2dee7cba4ab4f55cd6d809b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.5",
"size": 55326,
"upload_time": "2021-11-17T14:36:02",
"upload_time_iso_8601": "2021-11-17T14:36:02.007105Z",
"url": "https://files.pythonhosted.org/packages/10/81/ff637ea78b1d38eb50029d19a4dcb9c5eb037befeefdd44dca760d831b88/neuroglancer_scripts-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d02e2718b3919ea0e5838fe9e87445bece153ed9aa6e517c8047464a6c3ce453",
"md5": "950f8afb09e1649badfdac32eb8e835c",
"sha256": "524c0e3a3faebaf3952953f8097af347655bed3e70b3a4bc4043a6f216db7d28"
},
"downloads": -1,
"filename": "neuroglancer-scripts-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "950f8afb09e1649badfdac32eb8e835c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.5",
"size": 61770,
"upload_time": "2021-11-17T14:36:03",
"upload_time_iso_8601": "2021-11-17T14:36:03.240518Z",
"url": "https://files.pythonhosted.org/packages/d0/2e/2718b3919ea0e5838fe9e87445bece153ed9aa6e517c8047464a6c3ce453/neuroglancer-scripts-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-11-17 14:36:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "HumanBrainProject",
"github_project": "neuroglancer-scripts",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "neuroglancer-scripts"
}
JSON
