Metadata-Version: 2.1
Name: axon-synthesis
Version: 0.1.9
Summary: A package to synthesize artificial axons
Author: Blue Brain Project, EPFL
License: Apache License 2.0
Project-URL: Homepage, https://axon-synthesis.readthedocs.io
Project-URL: Repository, https://github.com/BlueBrain/axon-synthesis
Project-URL: Tracker, https://github.com/BlueBrain/axon-synthesis/issues
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
License-File: AUTHORS.md
Requires-Dist: attrs
Requires-Dist: BluePyParallel
Requires-Dist: brainbuilder>=0.18.3
Requires-Dist: click>=8
Requires-Dist: click_option_group>=0.5
Requires-Dist: configobj>=5
Requires-Dist: dask[dataframe]
Requires-Dist: gitpython
Requires-Dist: morph-tool
Requires-Dist: morphio
Requires-Dist: networkx
Requires-Dist: NeuroM<4,>3.2
Requires-Dist: NeuroTS<3.7,>=3.6
Requires-Dist: numpy
Requires-Dist: pandas>=1.5
Requires-Dist: pcst_fast
Requires-Dist: plotly
Requires-Dist: plotly-helper
Requires-Dist: pynrrd<1.1
Requires-Dist: pyarrow
Requires-Dist: scipy
Requires-Dist: seaborn
Requires-Dist: tables
Requires-Dist: typing_extensions
Requires-Dist: TMD
Requires-Dist: voxcell>=3.1.9
Requires-Dist: wurlitzer
Provides-Extra: examples
Requires-Dist: morphology-workflows; extra == "examples"
Provides-Extra: docs
Requires-Dist: kaleido; extra == "docs"
Requires-Dist: myst_parser; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-bluebrain-theme; extra == "docs"
Requires-Dist: sphinx-click; extra == "docs"
Provides-Extra: mpi
Requires-Dist: dask_mpi>=2022.4; extra == "mpi"
Requires-Dist: mpi4py>=3.1.1; extra == "mpi"
Provides-Extra: test
Requires-Dist: dir-content-diff>=1.9.1; extra == "test"
Requires-Dist: matplotlib>=3.5; extra == "test"
Requires-Dist: mock>=3; extra == "test"
Requires-Dist: pytest>=6.1; extra == "test"
Requires-Dist: pytest-click>=1.1; extra == "test"
Requires-Dist: pytest-console-scripts>=1.4; extra == "test"
Requires-Dist: pytest-cov>=4.1; extra == "test"
Requires-Dist: pytest-html>=3.2; extra == "test"
Provides-Extra: mypy
Requires-Dist: pandas-stubs; extra == "mypy"
Requires-Dist: pytest-mypy>=0.10; extra == "mypy"
Requires-Dist: types-jsonschema; extra == "mypy"
Requires-Dist: types-networkx; extra == "mypy"
Requires-Dist: types-PyYAML; extra == "mypy"
Requires-Dist: types-seaborn; extra == "mypy"
Provides-Extra: tecplot-export
Requires-Dist: construct; extra == "tecplot-export"
Requires-Dist: tecio; extra == "tecplot-export"

![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
