Skip to main content

Package to extract, visualize, convert and study interactions from database into executable activity flow based model

Project description

NeKo Logo
Tests Documentation

Neko is a Python package for extracting, visualizing, converting, and studying interactions from databases into executable activity flow-based models. It’s built on top of Omnipath, Pypath, and Atopo.

Citation

If you use NeKo in your research, please cite our paper:

Ruscone M, Tsirvouli E, Checcoli A, Turei D, Barillot E, et al. (2025) NeKo: A tool for automatic network construction from prior knowledge. PLOS Computational Biology 21(9): e1013300. https://doi.org/10.1371/journal.pcbi.1013300

Features

  • Network creation and manipulation

  • Connection of nodes and subnetworks

  • Gene-to-phenotype mapping

  • Network visualization and export helpers

  • Interaction database integration

  • Branching network history with automatic snapshots, HTML/SVG rendering, and state pruning controls

Installation

NeKo is still in its alpha version. You can install it from PyPI and also install the necessary external dependencies.

  1. Install `NeKo` from PyPI:

    Install the main package from PyPI (nekomata, do not confuse with pip install neko or pip install pyneko, those are other packages):

    pip install nekomata

Installation from Source

For the latest development version, you can still clone the repository and install directly from the source:

git clone https://github.com/sysbio-curie/Neko.git
cd Neko
pip install .

This will give you the latest version of NeKo (not officially released, so be aware there could be some bugs) along with the necessary external dependencies.

Troubleshooting

If during the installation you encounter problems with the installation of Graphviz, you could be missing basic Graphiz installation on your machine. You can install it on Linux system with the following command:

sudo apt-get install python3-dev graphviz libgraphviz-dev

or on Mac system:

brew install python3-dev graphviz libgraphviz-dev

For more details visit: https://graphviz.org/download/

Documentation

For full documentation, including API reference and detailed tutorials, visit our GitHub Pages documentation.

Jupyter Notebooks

We provide a comprehensive set of Jupyter notebooks that offer a detailed and user-friendly explanation of the package. These notebooks cover all modules of NeKo and provide a complete overview of how to use the package:

  1. Usage

  2. Build network using user-defined resources

  3. Stepwise connection: a focus on the INE algorithm

  4. Connect to upstream components

  5. Build network based on kinase-phosphosite interactions

  6. Connect to downstream Gene Ontology terms

  7. Map tissue expression

  8. Network comparison

  9. Re-creating famous pathways from SIGNOR and WIKIPATHWAYS using NeKo

  10. Import and complete a network

  11. Network history, branching, and visualisation

You can find these notebooks in the notebooks directory of the repository.

Features comparison with similar tools

Below you can find a table displaying the main features of NeKo compared to other similar tools: Features Table on GitHub.

Acknowledgements

This project is a collaborative effort between Institut Curie, NTNU, Saez lab and BSC.

Current contributors: Marco Ruscone, Eirini Tsirvouli, Andrea Checcoli, Dénes Turei, Aasmund Flobak, Emmanuel Barillot, Loredana Martignetti, Julio Saez-Rodriguez and Laurence Calzone.

version 1.1.0

  • Network creation and manipulation: The package allows for the creation of a network of nodes and edges, with various methods for enrichment analysis. This includes adding and removing nodes and edges, loading a network from a SIF (Simple Interaction Format) file, and adding paths to the edge list of the network.

  • Database integration: The package provides methods to integrate interactions from databases such as Omnipath, Signor, HURI and others. The user can also integrate personal resource to mine for interactions.

  • Database translation: The package provides methods to convert the identifiers of a database storing edges list, into Uniprot.

  • Connection of nodes: The package provides several methods to connect nodes in the network. This includes connecting all nodes, connecting a subgroup of nodes, connecting all nodes of a network object, and connecting subcomponents of a network object.

  • Connection of genes to phenotype: The package provides a method to connect genes to a phenotype based on provided parameters. This includes retrieving phenotype markers, identifying unique Uniprot genes, and connecting them to the network.

  • Branching network history: automatic state capture for every enrichment step, undo/redo, HTML/SVG graph visualisation, and configurable pruning via set_max_history.

Project details


Download files

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

Source Distribution

nekomata-1.1.0.tar.gz (61.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nekomata-1.1.0-py3-none-any.whl (73.9 kB view details)

Uploaded Python 3

File details

Details for the file nekomata-1.1.0.tar.gz.

File metadata

  • Download URL: nekomata-1.1.0.tar.gz
  • Upload date:
  • Size: 61.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for nekomata-1.1.0.tar.gz
Algorithm Hash digest
SHA256 33b91f2ea1a92467608bbaa5ab2c730983057d4440338d00531525f9f6997e35
MD5 68b22337e03b2333bfd89c53c87a2fa9
BLAKE2b-256 92dac1fec684104dfbf881900b07c65d8ff85a078c2db93bdf4b0d6cc0796063

See more details on using hashes here.

File details

Details for the file nekomata-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: nekomata-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 73.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for nekomata-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e036c27ac3edb5091aec8c91b9d1953a603de2f4c24615047c4c6847847898a
MD5 530f217538c8c4be5d9c69117da774ba
BLAKE2b-256 762b67fec3ec5a87b7b9fb95ca6002d3a6a4f90c48f4b3202a048e0ca6e1ad00

See more details on using hashes here.

Supported by

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