Metadata-Version: 2.4
Name: py_connectome_analysis
Version: 1.0.3
Summary: Methods for network analysis of graphs coming from brain models and activity on them
Author-Email: Daniela Egas Santander <daniela.egas.math@gmail.com>, Christoph Pokorny <christoph.pokorny@openbraininstitute.org>, Jason Smith <jason.smith@ntu.ac.uk>, Michael Wolfgang Reimann <mwr@reimann.science>
License-Expression: AGPL-3.0-or-later
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Project-URL: Documentation, https://openbraininstitute.github.io/connectome-analysis/
Project-URL: Homepage, https://openbraininstitute.github.io/connectome-analysis/
Project-URL: Repository, https://github.com/openbraininstitute/connectome-analysis.git
Requires-Python: <3.13,>=3.9
Requires-Dist: tables>3.8
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: progressbar==2.5
Requires-Dist: tqdm
Requires-Dist: pyflagser
Requires-Dist: pyflagsercount>=0.2.41
Requires-Dist: networkx
Requires-Dist: scikit-network
Requires-Dist: ipykernel<7,>=6.29.5
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: mkdocstrings[python]>=0.18; extra == "dev"
Requires-Dist: mkdocs-material; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-github-actions-annotate-failures; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: seaborn; extra == "dev"
Description-Content-Type: text/markdown

# connectome_analysis

[![PyPI](https://img.shields.io/pypi/v/connectome_analysis?style=flat-square)](https://pypi.python.org/pypi/connectome_analysis/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/connectome_analysis?style=flat-square)](https://pypi.python.org/pypi/connectome_analysis/)
[![PyPI - License](https://img.shields.io/pypi/l/connectome_analysis?style=flat-square)](https://pypi.python.org/pypi/connectome_analysis/)


---

**Documentation**: [https://danielaegassan.github.io/connectome_analysis](https://danielaegassan.github.io/connectome_analysis)

**Source Code**: [https://github.com/danielaegassan/connectome_analysis](https://github.com/danielaegassan/connectome_analysis)

**PyPI**: [https://pypi.org/project/connectome_analysis/](https://pypi.org/project/connectome_analysis/)

---

Library of general functions to analyze connectoms.

## Installation

```sh
pip install connectome_analysis
```

## Development

* Clone this repository
* Requirements:
  * [Poetry](https://python-poetry.org/)
  * [gcc](https://gcc.gnu.org/) 9
  * [CMake](https://cmake.org/)
  * Python 3.8+

* Create a virtual environment and install the dependencies

```sh
poetry install
```

CMake may have difficulties to find the right compilers to compile the C++ code. 
If that is the case, you have to specify the path to the compilers yourself:

```sh
CC=/path/to/gcc CXX=/path/to/g++ poetry install
```

This is especially important on MacOS.

* Activate the virtual environment

```sh
poetry shell
```

### Testing

```sh
pytest tests
```

### Documentation

The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings
 of the public signatures of the source code. The documentation is updated and published as a [Github project page
 ](https://pages.github.com/) automatically as part each release.
