Skip to main content

Python package to generate and study graphs and detailed spatial or biological networks.

Project description

NNGT: a unified interface for networks in python

Logo of NNGT: a conceptual sketch of a pyramidal neuron linked to three
simple circular nodes to form a graph.

CI status REUSE compliant Coverage Status Documentation Status License: GPLv3+
DOI PyPI

The Neural Networks and Graphs' Topology (NNGT) module provides tools to generate and study graphs and detailed biological networks. It also lets user interface efficient graph libraries with highly distributed activity simulators to make the study of neuronal activity as easy and efficient as possible.

Source code is available and contributions are accepted on SourceHut (preferred), Codeberg, and GitHub.

For questions or issues, please check the mailing list and the issue tracker.

Principle

NNGT provides a unified interface that acts as a wrapper for 3 major graph libraries in Python: networkx, igraph, and graph-tool.

Use the same code, run it at home on the latest linux with graph-tool, then on your collaborator's laptop with networkx on Windows, no changes required!

In addition to this common interface, NNGT provides additional tools and methods to generate complex neuronal networks. Once the networks are created, they can be seamlessly sent to the nest-simulator, which will generate activity. This activity can then be analyzed together with the structure using NNGT.

Eventually, NNGT is also able to import neuronal networks generated using the DeNSE simulator for neuronal growth.

Install and use the library

NNGT requires Python 3.5+ since version 2.0, and is directly available on Pypi. To install it, make sure you have a valid Python installation, then do:

pip install nngt

If you want to use it with advanced geometry, geospatial or other tools, you can use the various extra to automatically download the relevant dependencies keep only one of the listed possibilities)

pip install nngt[matplotlib|nx|ig|geometry|geospatial]

To install all dependencies, use pip install nngt[full].

To use it, once installed, open a Python terminal or script file and type

import nngt

If you want to have the latest updates before they are released into a stable version, you can install directly from main via:

pip install --user git+https://git.sr.ht/~tfardet/NNGT@main

Support and bug reports

For general questions or support, you can write the mailing list.

If you stumble on bugs you can report them on the issue tracker.

Cloning/updating the repository

This repository includes the PyNCultures package from the SENeC initiative as its geometry module, using the git submodule feature. It also uses mpl_chord_diagram whithin the plot module. Thus, when cloning the repository, you must do:

git clone https://git.sr.ht/~tfardet/NNGT
cd NNGT && git submodule init && git submodule update

To update your local repository, do:

git pull
git submodule update --remote --merge

Features

Compatibility

  • Currently supports graph-tool (>= 2.46), igraph, and networkx (>= 2.4).
  • Interactions with NEST and DeNSE.

Status

  • Standard functions and graph generation algorithms.
  • Special methods for graph analysis on weighted directed networks.
  • Full support for node and edge attributes.
  • Extended I/O features as well as graphical representations.
  • Advanced methods to design neuronal networks.
  • Supports complex 2D structures with shapely.

See documentation on ReadTheDocs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

NNGT-2.8.0-cp312-cp312-manylinux_2_28_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.28+ x86-64

NNGT-2.8.0-cp311-cp311-manylinux_2_28_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.28+ x86-64

NNGT-2.8.0-cp310-cp310-manylinux_2_28_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.28+ x86-64

NNGT-2.8.0-cp39-cp39-manylinux_2_28_x86_64.whl (1.7 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.28+ x86-64

NNGT-2.8.0-cp38-cp38-manylinux_2_28_x86_64.whl (1.8 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.28+ x86-64

NNGT-2.8.0-cp37-cp37m-manylinux_2_28_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.7m manylinux: glibc 2.28+ x86-64

File details

Details for the file NNGT-2.8.0-cp312-cp312-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for NNGT-2.8.0-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 44b8f3b2b3647ac8b4de39cb7c1ec6250a48f93b21662c1e231fb2a4adec53bc
MD5 4dca07946a334bf6926c9bda31fbc4ad
BLAKE2b-256 371b366cfca37de1efdb07e11148874600905b77bc1796513a82cffd027fa76f

See more details on using hashes here.

File details

Details for the file NNGT-2.8.0-cp311-cp311-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for NNGT-2.8.0-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 43b832b0d4ba31c8e4d95949b3392004496971a5c18341411f1017a5ffb415a4
MD5 79151906393f0e85fc8e4f45a73d1cf4
BLAKE2b-256 2f391f3eca5523e2763294190248ae3a89dcf5382e7c0655baa37198e8e64460

See more details on using hashes here.

File details

Details for the file NNGT-2.8.0-cp310-cp310-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for NNGT-2.8.0-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 efcc1fd675d203d72691d685da95a4a381c8b97942662c74c085a4cc18728908
MD5 b475bb2b67b7fae349b1e38abe30db8a
BLAKE2b-256 629755ea97768fdcfa522d26c150561228b8831ff618d8aca886c0801dddbbc1

See more details on using hashes here.

File details

Details for the file NNGT-2.8.0-cp39-cp39-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for NNGT-2.8.0-cp39-cp39-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e25313d6e26ea45543ccedd8b89b2fd33bdfcd174bd6407b4fad5d58b4404cd9
MD5 b9b1b09cbd055b4d1720ee60f157deb2
BLAKE2b-256 d15fbd83f5eb0414a2ac2c99a13e95ff676729ce47ac92c121277553a16190cb

See more details on using hashes here.

File details

Details for the file NNGT-2.8.0-cp38-cp38-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for NNGT-2.8.0-cp38-cp38-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 199768bcbf2f852b6d568a15265fd39f13d38e7aea2cd14b4f6d5aa0a2a9ab94
MD5 8010c7266fe55234f85e66aa6be8be4d
BLAKE2b-256 ca5a86dfd98b1885ecf0692e39e06eff19c8ad68ea9b7d3968b63b8ce8d752a6

See more details on using hashes here.

File details

Details for the file NNGT-2.8.0-cp37-cp37m-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for NNGT-2.8.0-cp37-cp37m-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 15e3145d966a370d55e3f5a2214b20299a560967cfd813ab28418ded3cee9319
MD5 6d81f444e1207c49c56fc5b0749b7e4e
BLAKE2b-256 d5be3f9d80f25389d24598bd99dc00d841836bb1a13be6fd71f23c34d2525d52

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page