axon-synthesis


Nameaxon-synthesis JSON
Version 0.1.10 PyPI version JSON
download
home_pageNone
SummaryA package to synthesize artificial axons
upload_time2024-12-13 14:45:00
maintainerNone
docs_urlNone
authorBlue Brain Project, EPFL
requires_python>=3.10
licenseApache License 2.0
keywords
VCS
bugtrack_url
requirements attrs BluePyParallel brainbuilder click click_option_group configobj dask gitpython morph-tool morphio networkx NeuroM NeuroTS numpy pandas pcst_fast plotly plotly-helper pynrrd pyarrow scipy seaborn tables typing_extensions TMD voxcell wurlitzer
Travis-CI No Travis.
coveralls test coverage
            ![AxonSynthesis Logo](docs/source/BBP-Axon-Synthesis.jpg)

# Axon Synthesis

[![Version](https://img.shields.io/pypi/v/axon-synthesis)](https://github.com/BlueBrain/AxonSynthesis/releases)
[![Build status](https://github.com/BlueBrain/axon-synthesis/actions/workflows/run-tox.yml/badge.svg?branch=main)](https://github.com/BlueBrain/axon-synthesis/actions)
[![Codecov.io](https://codecov.io/github/BlueBrain/axon-synthesis/coverage.svg?branch=main)](https://codecov.io/github/BlueBrain/axon-synthesis?branch=main)
[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Documentation status](https://readthedocs.org/projects/axon-synthesis/badge/?version=latest)](https://axon-synthesis.readthedocs.io/)
[![DOI](https://img.shields.io/badge/DOI-10.1101/2024.10.16.618695-blue)](https://doi.org/10.1101/2024.10.16.618695)


A package to synthesize artificial axons.

The main documentation, is available here: [https://axon-synthesis.readthedocs.io](https://axon-synthesis.readthedocs.io)


### Installation

It is recommended to install ``axon-synthesis`` using [pip](https://pip.pypa.io/en/stable/):

```bash
pip install axon-synthesis
```


### Examples

An example can be found in the ``examples`` directory.
This example contains a small input dataset and a ``run.sh`` script that will execute the code.
The inputs can be reviewed and modified for testing.


### Citation

When you use the ``axon-synthesis`` software or method for your research, we ask you to cite the
publication associated to this repository (use the ``Cite this repository`` button on the
[main page](https://github.com/BlueBrain/axon-synthesis) of the code).


### 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.

For license and authors, see `LICENSE.txt` and `AUTHORS.md` respectively.

Copyright © 2023-2024 Blue Brain Project, EPFL

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "axon-synthesis",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Blue Brain Project, EPFL",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/c7/81/28163499f1e61f0eea09d2c95344746b2c157a6932f9f50674fd96542ffc/axon_synthesis-0.1.10.tar.gz",
    "platform": null,
    "description": "![AxonSynthesis Logo](docs/source/BBP-Axon-Synthesis.jpg)\n\n# Axon Synthesis\n\n[![Version](https://img.shields.io/pypi/v/axon-synthesis)](https://github.com/BlueBrain/AxonSynthesis/releases)\n[![Build status](https://github.com/BlueBrain/axon-synthesis/actions/workflows/run-tox.yml/badge.svg?branch=main)](https://github.com/BlueBrain/axon-synthesis/actions)\n[![Codecov.io](https://codecov.io/github/BlueBrain/axon-synthesis/coverage.svg?branch=main)](https://codecov.io/github/BlueBrain/axon-synthesis?branch=main)\n[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Documentation status](https://readthedocs.org/projects/axon-synthesis/badge/?version=latest)](https://axon-synthesis.readthedocs.io/)\n[![DOI](https://img.shields.io/badge/DOI-10.1101/2024.10.16.618695-blue)](https://doi.org/10.1101/2024.10.16.618695)\n\n\nA package to synthesize artificial axons.\n\nThe main documentation, is available here: [https://axon-synthesis.readthedocs.io](https://axon-synthesis.readthedocs.io)\n\n\n### Installation\n\nIt is recommended to install ``axon-synthesis`` using [pip](https://pip.pypa.io/en/stable/):\n\n```bash\npip install axon-synthesis\n```\n\n\n### Examples\n\nAn example can be found in the ``examples`` directory.\nThis example contains a small input dataset and a ``run.sh`` script that will execute the code.\nThe inputs can be reviewed and modified for testing.\n\n\n### Citation\n\nWhen you use the ``axon-synthesis`` software or method for your research, we ask you to cite the\npublication associated to this repository (use the ``Cite this repository`` button on the\n[main page](https://github.com/BlueBrain/axon-synthesis) of the code).\n\n\n### Funding & Acknowledgment\n\nThe development of this software was supported by funding to the Blue Brain Project, a research\ncenter of the \u00c9cole polytechnique f\u00e9d\u00e9rale de Lausanne (EPFL), from the Swiss government\u2019s ETH\nBoard of the Swiss Federal Institutes of Technology.\n\nFor license and authors, see `LICENSE.txt` and `AUTHORS.md` respectively.\n\nCopyright \u00a9 2023-2024 Blue Brain Project, EPFL\n",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "A package to synthesize artificial axons",
    "version": "0.1.10",
    "project_urls": {
        "Homepage": "https://axon-synthesis.readthedocs.io",
        "Repository": "https://github.com/BlueBrain/axon-synthesis",
        "Tracker": "https://github.com/BlueBrain/axon-synthesis/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e0235a765bd42c92d1b11f8eba2803be9d17cca1802560251514c4ac5629b6ac",
                "md5": "1a7300b347aca97fd5c10b98c7bffe3e",
                "sha256": "2a02f4ee85aebe3624af8b770045eb2b4961accc2d3f692c90a4d43c69833eef"
            },
            "downloads": -1,
            "filename": "axon_synthesis-0.1.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1a7300b347aca97fd5c10b98c7bffe3e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 143596,
            "upload_time": "2024-12-13T14:44:57",
            "upload_time_iso_8601": "2024-12-13T14:44:57.823508Z",
            "url": "https://files.pythonhosted.org/packages/e0/23/5a765bd42c92d1b11f8eba2803be9d17cca1802560251514c4ac5629b6ac/axon_synthesis-0.1.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c78128163499f1e61f0eea09d2c95344746b2c157a6932f9f50674fd96542ffc",
                "md5": "c138cf77ab46818269cc1217b014df69",
                "sha256": "22c1d6f96e711fc71583306090241c84e1517c09b89b4eac2365380391397c81"
            },
            "downloads": -1,
            "filename": "axon_synthesis-0.1.10.tar.gz",
            "has_sig": false,
            "md5_digest": "c138cf77ab46818269cc1217b014df69",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 8368971,
            "upload_time": "2024-12-13T14:45:00",
            "upload_time_iso_8601": "2024-12-13T14:45:00.699504Z",
            "url": "https://files.pythonhosted.org/packages/c7/81/28163499f1e61f0eea09d2c95344746b2c157a6932f9f50674fd96542ffc/axon_synthesis-0.1.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-13 14:45:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BlueBrain",
    "github_project": "axon-synthesis",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "attrs",
            "specs": []
        },
        {
            "name": "BluePyParallel",
            "specs": []
        },
        {
            "name": "brainbuilder",
            "specs": [
                [
                    ">=",
                    "0.18.3"
                ]
            ]
        },
        {
            "name": "click",
            "specs": [
                [
                    ">=",
                    "8"
                ]
            ]
        },
        {
            "name": "click_option_group",
            "specs": [
                [
                    ">=",
                    "0.5"
                ]
            ]
        },
        {
            "name": "configobj",
            "specs": [
                [
                    ">=",
                    "5"
                ]
            ]
        },
        {
            "name": "dask",
            "specs": []
        },
        {
            "name": "gitpython",
            "specs": []
        },
        {
            "name": "morph-tool",
            "specs": []
        },
        {
            "name": "morphio",
            "specs": []
        },
        {
            "name": "networkx",
            "specs": []
        },
        {
            "name": "NeuroM",
            "specs": [
                [
                    ">",
                    "3.2"
                ],
                [
                    "<",
                    "4"
                ]
            ]
        },
        {
            "name": "NeuroTS",
            "specs": [
                [
                    "<",
                    "3.7"
                ],
                [
                    ">=",
                    "3.6"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "pandas",
            "specs": [
                [
                    ">=",
                    "1.5"
                ]
            ]
        },
        {
            "name": "pcst_fast",
            "specs": []
        },
        {
            "name": "plotly",
            "specs": []
        },
        {
            "name": "plotly-helper",
            "specs": []
        },
        {
            "name": "pynrrd",
            "specs": [
                [
                    "<",
                    "1.1"
                ]
            ]
        },
        {
            "name": "pyarrow",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": []
        },
        {
            "name": "seaborn",
            "specs": []
        },
        {
            "name": "tables",
            "specs": []
        },
        {
            "name": "typing_extensions",
            "specs": []
        },
        {
            "name": "TMD",
            "specs": []
        },
        {
            "name": "voxcell",
            "specs": [
                [
                    ">=",
                    "3.1.9"
                ]
            ]
        },
        {
            "name": "wurlitzer",
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "axon-synthesis"
}
        
Elapsed time: 0.41337s