MVDTool


NameMVDTool JSON
Version 2.4.11 PyPI version JSON
download
home_pagehttps://github.com/BlueBrain/MVDTool
SummaryPython bindings to the MVD3 neuroscience file format
upload_time2022-12-07 10:07:54
maintainer
docs_urlNone
authorBlue Brain Project, EPFL
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            # MVD-tool

## Information

A simple C++ parser and tool for the MVD3 and Sonata neuroscience file formats

* provide a tool to convert MVD2 to MVD3
* provide a tool to export MVD to CSV
* provide a simple header base parser for MVD2
* provide a parser based on the HighFive library for MVD3 and Sonata

It also provides a high level Python API for parsing MVD3 and Sonata files.

## Compilation

#### Prerequisites
 - CMake >= 3.0
 - GCC >= 4.9
 - BOOST >= 1.41
 - HighFive
 - libSONATA

#### Compile and Install the C++ parser

```bash
mkdir build; pushd build
cmake ../ -DCMAKE_INSTALL_PREFIX=<install_dir>
make
make install
```
#### Compile and Install the Python API
```bash
python setup.py install
```

## Examples with the Python API

#### Reading Sonata files
```python
import mvdtool
node = mvdtool.open("tests/nodes.h5")
# retrieve data for the full range
node.morphologies()
# retrieve data for a certain range
node.morphologies([0, 1, 3])
```

#### Reading MVD3 files
```python
import mvdtool
mvd = mvdtool.open("tests/circuit.mvd3")
mvd.morphologies()
```
Certain attributes in MVD files require the information from the mecombo file. In this case, it's strictly necessary that the mecombo file contains all combos from the MVD file.
```python
mvd_tsv = mvdtool.open("tests/circuit_tsv.mvd3")
mvd_tsv.open_combo_tsv("tests/mecombo_emodel.tsv")
mvd_tsv.emodels()
```

## Funding & Acknowledgment
 
The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.
 
Copyright © 2015-2022 Blue Brain Project/EPFL


## License

LGPLv2.1+

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/BlueBrain/MVDTool",
    "name": "MVDTool",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Blue Brain Project, EPFL",
    "author_email": "bbp-ou-hpc@groupes.epfl.ch",
    "download_url": "https://files.pythonhosted.org/packages/1d/05/14fc4407234bb4bad00d8b378f2358fa939abdb6b046f83992b6de2a8954/MVDTool-2.4.11.tar.gz",
    "platform": null,
    "description": "# MVD-tool\n\n## Information\n\nA simple C++ parser and tool for the MVD3 and Sonata neuroscience file formats\n\n* provide a tool to convert MVD2 to MVD3\n* provide a tool to export MVD to CSV\n* provide a simple header base parser for MVD2\n* provide a parser based on the HighFive library for MVD3 and Sonata\n\nIt also provides a high level Python API for parsing MVD3 and Sonata files.\n\n## Compilation\n\n#### Prerequisites\n - CMake >= 3.0\n - GCC >= 4.9\n - BOOST >= 1.41\n - HighFive\n - libSONATA\n\n#### Compile and Install the C++ parser\n\n```bash\nmkdir build; pushd build\ncmake ../ -DCMAKE_INSTALL_PREFIX=<install_dir>\nmake\nmake install\n```\n#### Compile and Install the Python API\n```bash\npython setup.py install\n```\n\n## Examples with the Python API\n\n#### Reading Sonata files\n```python\nimport mvdtool\nnode = mvdtool.open(\"tests/nodes.h5\")\n# retrieve data for the full range\nnode.morphologies()\n# retrieve data for a certain range\nnode.morphologies([0, 1, 3])\n```\n\n#### Reading MVD3 files\n```python\nimport mvdtool\nmvd = mvdtool.open(\"tests/circuit.mvd3\")\nmvd.morphologies()\n```\nCertain attributes in MVD files require the information from the mecombo file. In this case, it's strictly necessary that the mecombo file contains all combos from the MVD file.\n```python\nmvd_tsv = mvdtool.open(\"tests/circuit_tsv.mvd3\")\nmvd_tsv.open_combo_tsv(\"tests/mecombo_emodel.tsv\")\nmvd_tsv.emodels()\n```\n\n## Funding & Acknowledgment\n \nThe development of this software was supported by funding to the Blue Brain Project, a research center of the \u00c9cole polytechnique f\u00e9d\u00e9rale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.\n \nCopyright \u00a9 2015-2022 Blue Brain Project/EPFL\n\n\n## License\n\nLGPLv2.1+\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Python bindings to the MVD3 neuroscience file format",
    "version": "2.4.11",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "343fa83cf3dc109a3c3bc96fa4a34eb5",
                "sha256": "deaf7ed7a2bb9fb7913305e1520599986578aa528c4be891c972aa32bacb41a6"
            },
            "downloads": -1,
            "filename": "MVDTool-2.4.11-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "343fa83cf3dc109a3c3bc96fa4a34eb5",
            "packagetype": "bdist_wheel",
            "python_version": "cp310",
            "requires_python": null,
            "size": 2410762,
            "upload_time": "2022-12-07T10:07:45",
            "upload_time_iso_8601": "2022-12-07T10:07:45.053965Z",
            "url": "https://files.pythonhosted.org/packages/ce/fe/b4862f57abc70b0020e9bd9534daac22659ea5ec16133ede0696f4bdf745/MVDTool-2.4.11-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "c80ff693e3268349e9729ca032808577",
                "sha256": "11151ca1187d3dad575e98a5e0b243851746b314da2ed891f9b2775114b69122"
            },
            "downloads": -1,
            "filename": "MVDTool-2.4.11-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "c80ff693e3268349e9729ca032808577",
            "packagetype": "bdist_wheel",
            "python_version": "cp311",
            "requires_python": null,
            "size": 2410375,
            "upload_time": "2022-12-07T10:07:47",
            "upload_time_iso_8601": "2022-12-07T10:07:47.376275Z",
            "url": "https://files.pythonhosted.org/packages/6d/ce/1435a5ce00f2777293aaf7e2258d7bc1794b565b610d0f88008c83a60250/MVDTool-2.4.11-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "28c3c783247fb30aa3d3f94da54c8d3d",
                "sha256": "2af659e3d94a7fe03f0867fdb08651c13acbbced4f3601c4ffc8f9588a05d9d2"
            },
            "downloads": -1,
            "filename": "MVDTool-2.4.11-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "28c3c783247fb30aa3d3f94da54c8d3d",
            "packagetype": "bdist_wheel",
            "python_version": "cp37",
            "requires_python": null,
            "size": 2403024,
            "upload_time": "2022-12-07T10:07:49",
            "upload_time_iso_8601": "2022-12-07T10:07:49.840085Z",
            "url": "https://files.pythonhosted.org/packages/38/3a/97dc367e0e0c3d95e5e5c689f7bcc48261cfefec429fbc71a7a9f304e8a7/MVDTool-2.4.11-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "c7f300a0f838aebaf75a4d4d35b73264",
                "sha256": "18cfa091e53c5ca18ba679654f4c50fe4bfa5e4b0f470f47bf092f11c4c3a076"
            },
            "downloads": -1,
            "filename": "MVDTool-2.4.11-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "c7f300a0f838aebaf75a4d4d35b73264",
            "packagetype": "bdist_wheel",
            "python_version": "cp38",
            "requires_python": null,
            "size": 2408741,
            "upload_time": "2022-12-07T10:07:51",
            "upload_time_iso_8601": "2022-12-07T10:07:51.415244Z",
            "url": "https://files.pythonhosted.org/packages/08/26/65821e9ca18e685b9ecbe53b5bf87c1730fab52cf4eb6a380d6888d838c2/MVDTool-2.4.11-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "49dcf1652fcfefb1f501832d51ef7680",
                "sha256": "095b1f989bbacb4b39b289425d1e71e7848fc406ddb9186dd04ea9c14911c912"
            },
            "downloads": -1,
            "filename": "MVDTool-2.4.11-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "has_sig": false,
            "md5_digest": "49dcf1652fcfefb1f501832d51ef7680",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": null,
            "size": 2410343,
            "upload_time": "2022-12-07T10:07:53",
            "upload_time_iso_8601": "2022-12-07T10:07:53.151424Z",
            "url": "https://files.pythonhosted.org/packages/31/9c/3fb0ac702d39b42448ef7e5e9a40a46d50950f769e5a55a8ff384240896d/MVDTool-2.4.11-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "1d653ff8507b3c54b76c9df631dc2de3",
                "sha256": "fed7b76caca911b1d99e6299a86e447afad5aadad0bccdb2f9b72863b2c5da84"
            },
            "downloads": -1,
            "filename": "MVDTool-2.4.11.tar.gz",
            "has_sig": false,
            "md5_digest": "1d653ff8507b3c54b76c9df631dc2de3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 642462,
            "upload_time": "2022-12-07T10:07:54",
            "upload_time_iso_8601": "2022-12-07T10:07:54.968117Z",
            "url": "https://files.pythonhosted.org/packages/1d/05/14fc4407234bb4bad00d8b378f2358fa939abdb6b046f83992b6de2a8954/MVDTool-2.4.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-07 10:07:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "BlueBrain",
    "github_project": "MVDTool",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mvdtool"
}
        
Elapsed time: 0.01882s