[![Build Status](https://travis-ci.com/JustasB/pylmeasure.svg?branch=master)](https://travis-ci.com/JustasB/pylmeasure)
[![codecov](https://codecov.io/gh/JustasB/pylmeasure/branch/master/graph/badge.svg)](https://codecov.io/gh/JustasB/pylmeasure)
[![PyPI version](https://badge.fury.io/py/pylmeasure.svg)](https://badge.fury.io/py/pylmeasure)
# PyLMeasure: A Python Wrapper for LMeasure.
[PyLMeasure](https://pypi.org/project/pylmeasure/) is a Python wrapper library for the [command-line interface](http://cng.gmu.edu:8080/Lm/help/cmdLineUsageDoc.html) of the neuronal morphology analysis tool [L-Measure](http://cng.gmu.edu:8080/Lm/help/index.htm).
# Installation
To install the library, simply type in `pip install pylmeasure` in your terminal.
The above command includes the necessary binaries -- no need to download L-Measure separatelly or install Java.
# Usage
The basic usage is:
```
from pylmeasure import *
# Specify the L-Measure to compute, full list: http://cng.gmu.edu:8080/Lm/help/index.htm
LMOutput = getOneMeasure('Surface', 'path/to/cell.swc')
print("Surface area:", LMOutput["TotalSum"])
```
For more examples, see [this Jupyter notebook](https://github.com/JustasB/pylmeasure/blob/master/PyLMeasure%20Usage.ipynb).
# Issues
If you encounter an issue, first make sure it's not due to L-Measure itself -- this library simply wraps the L-Measure executables. If it is, please contact the [L-Measure team](http://cng.gmu.edu:8080/Lm/). If the issue is with this library, please create an [issue on Github](https://github.com/JustasB/pylmeasure/issues).
# Contributing
To contribute, please [open an issue](https://github.com/JustasB/pylmeasure/issues) first and discuss your plan for contributing. Then fork this repository and commit [a pull-request](https://help.github.com/en/articles/about-pull-requests) with your changes.
# Acknowledgements
This wrapper library project was initialy started by [Ajayrama Kumaraswamy](https://github.com/ajkswamy). View [the original source](https://github.com/ajkswamy/python-Lmeasure).
Raw data
{
"_id": null,
"home_page": "https://github.com/justasb/pylmeasure",
"name": "pylmeasure",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ajayrama Kumaraswamy, Justas Birgiolas",
"author_email": "justas@asu.edu",
"download_url": "",
"platform": "",
"description": "[![Build Status](https://travis-ci.com/JustasB/pylmeasure.svg?branch=master)](https://travis-ci.com/JustasB/pylmeasure)\n[![codecov](https://codecov.io/gh/JustasB/pylmeasure/branch/master/graph/badge.svg)](https://codecov.io/gh/JustasB/pylmeasure)\n[![PyPI version](https://badge.fury.io/py/pylmeasure.svg)](https://badge.fury.io/py/pylmeasure)\n\n# PyLMeasure: A Python Wrapper for LMeasure.\n\n[PyLMeasure](https://pypi.org/project/pylmeasure/) is a Python wrapper library for the [command-line interface](http://cng.gmu.edu:8080/Lm/help/cmdLineUsageDoc.html) of the neuronal morphology analysis tool [L-Measure](http://cng.gmu.edu:8080/Lm/help/index.htm).\n\n# Installation\n\nTo install the library, simply type in `pip install pylmeasure` in your terminal.\n\nThe above command includes the necessary binaries -- no need to download L-Measure separatelly or install Java.\n\n# Usage\n\nThe basic usage is:\n\n```\nfrom pylmeasure import *\n\n# Specify the L-Measure to compute, full list: http://cng.gmu.edu:8080/Lm/help/index.htm\nLMOutput = getOneMeasure('Surface', 'path/to/cell.swc')\n\nprint(\"Surface area:\", LMOutput[\"TotalSum\"])\n```\n\nFor more examples, see [this Jupyter notebook](https://github.com/JustasB/pylmeasure/blob/master/PyLMeasure%20Usage.ipynb).\n\n# Issues\nIf you encounter an issue, first make sure it's not due to L-Measure itself -- this library simply wraps the L-Measure executables. If it is, please contact the [L-Measure team](http://cng.gmu.edu:8080/Lm/). If the issue is with this library, please create an [issue on Github](https://github.com/JustasB/pylmeasure/issues).\n\n# Contributing\n\nTo contribute, please [open an issue](https://github.com/JustasB/pylmeasure/issues) first and discuss your plan for contributing. Then fork this repository and commit [a pull-request](https://help.github.com/en/articles/about-pull-requests) with your changes.\n\n# Acknowledgements\n\nThis wrapper library project was initialy started by [Ajayrama Kumaraswamy](https://github.com/ajkswamy). View [the original source](https://github.com/ajkswamy/python-Lmeasure).\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A Python wrapper for L-Measure",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/justasb/pylmeasure"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "540d30f9b193a5fd28558c3ce8419b5527d7ce26e18f4428271fdaaa032c6bc3",
"md5": "52545db3e9b0f0e6d2d2962fc80fdd7c",
"sha256": "9937930eda67648467a3e5d8da8f6d76fd709acdfda51e8131520887c6fc4ad9"
},
"downloads": -1,
"filename": "pylmeasure-0.2.0-py2-none-any.whl",
"has_sig": false,
"md5_digest": "52545db3e9b0f0e6d2d2962fc80fdd7c",
"packagetype": "bdist_wheel",
"python_version": "py2",
"requires_python": null,
"size": 3125659,
"upload_time": "2019-12-23T19:40:59",
"upload_time_iso_8601": "2019-12-23T19:40:59.279533Z",
"url": "https://files.pythonhosted.org/packages/54/0d/30f9b193a5fd28558c3ce8419b5527d7ce26e18f4428271fdaaa032c6bc3/pylmeasure-0.2.0-py2-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fdf243f78eb11f4f4a57447e2d2d428be3a1accbede329c2aed5f51006aa1f2",
"md5": "1d649f6fd7f128d7c45706e7639a58a8",
"sha256": "d56f37623d627fa85b1775408980b52f03ad5244388da98b4ea88cf62648aa6e"
},
"downloads": -1,
"filename": "pylmeasure-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1d649f6fd7f128d7c45706e7639a58a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 3122201,
"upload_time": "2019-12-23T19:41:03",
"upload_time_iso_8601": "2019-12-23T19:41:03.768812Z",
"url": "https://files.pythonhosted.org/packages/0f/df/243f78eb11f4f4a57447e2d2d428be3a1accbede329c2aed5f51006aa1f2/pylmeasure-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-12-23 19:40:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "justasb",
"github_project": "pylmeasure",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "numpy",
"specs": []
},
{
"name": "Pint",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "codecov",
"specs": []
},
{
"name": "pyparsing",
"specs": []
}
],
"lcname": "pylmeasure"
}