=========================
NeKo: Network Konstructor
=========================
.. figure:: docs/src/neko_logo.png
:align: right
:figwidth: 50px
:alt: NeKo Logo
.. image:: https://github.com/sysbio-curie/Neko/actions/workflows/build.yaml/badge.svg
:target: https://github.com/sysbio-curie/Neko/actions/workflows/build.yaml
:alt: Tests
.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
:target: https://sysbio-curie.github.io/Neko/
:alt: 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 <https://github.com/saezlab/omnipath>`_, `Pypath <https://github.com/saezlab/pypath>`_, and `Atopo <https://github.com/druglogics/atopo>`_.
**Note**: Neko is currently in development and approaching its final stages. It is available on pip under the name "nekomata".
Features
--------
- Network creation and manipulation
- Connection of nodes and subnetworks
- Gene-to-phenotype mapping
- Network visualization
- Interaction database integration
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**:
First, install the main package from PyPI (nekomata, do not confuse with pip install neko or pip install pyneko, those are other packages):
.. code-block:: bash
pip install nekomata
2. **Install External Dependencies**:
`NeKo` requires some external dependencies that are not available on PyPI. To install these dependencies, run:
.. code-block:: bash
pip install -r https://raw.githubusercontent.com/sysbio-curie/Neko/main/requirements.txt
This two-step process will install both the core `NeKo` package and its external dependencies.
Installation from Source
------------------------
For the latest development version, you can still clone the repository and install directly from the source:
.. code-block:: bash
git clone https://github.com/sysbio-curie/Neko.git
cd Neko
pip install .
pip install -r requirements.txt
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:
.. code-block:: bash
sudo apt-get install python3-dev graphviz libgraphviz-dev
or on Mac system:
.. code-block:: bash
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 <https://sysbio-curie.github.io/Neko/>`_.
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
You can find these notebooks in the `notebooks` directory of the repository.
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 0.9.4
--------------
- 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. There is also an option to compress the network by substituting specified genes with the phenotype name.
Raw data
{
"_id": null,
"home_page": "https://github.com/sysbio-curie/Neko",
"name": "nekomata",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Marco Ruscone",
"author_email": "marco.ruscone@curie.fr",
"download_url": "https://files.pythonhosted.org/packages/6e/0b/3e0ab7a204a871650897b055f8ffd3497c5fc9850243883fab8b31ac2d20/nekomata-0.9.8.tar.gz",
"platform": null,
"description": "=========================\nNeKo: Network Konstructor\n=========================\n\n.. figure:: docs/src/neko_logo.png\n :align: right\n :figwidth: 50px\n :alt: NeKo Logo\n\n.. image:: https://github.com/sysbio-curie/Neko/actions/workflows/build.yaml/badge.svg\n :target: https://github.com/sysbio-curie/Neko/actions/workflows/build.yaml\n :alt: Tests\n\n.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg\n :target: https://sysbio-curie.github.io/Neko/\n :alt: Documentation\n\nNeko 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 <https://github.com/saezlab/omnipath>`_, `Pypath <https://github.com/saezlab/pypath>`_, and `Atopo <https://github.com/druglogics/atopo>`_.\n\n**Note**: Neko is currently in development and approaching its final stages. It is available on pip under the name \"nekomata\".\n\nFeatures\n--------\n\n- Network creation and manipulation\n- Connection of nodes and subnetworks\n- Gene-to-phenotype mapping\n- Network visualization\n- Interaction database integration\n\nInstallation\n------------\n\n`NeKo` is still in its alpha version. You can install it from PyPI and also install the necessary external dependencies.\n\n1. **Install `NeKo` from PyPI**:\n\n First, install the main package from PyPI (nekomata, do not confuse with pip install neko or pip install pyneko, those are other packages):\n\n .. code-block:: bash\n\n pip install nekomata\n\n2. **Install External Dependencies**:\n\n `NeKo` requires some external dependencies that are not available on PyPI. To install these dependencies, run:\n\n .. code-block:: bash\n\n pip install -r https://raw.githubusercontent.com/sysbio-curie/Neko/main/requirements.txt\n\nThis two-step process will install both the core `NeKo` package and its external dependencies.\n\nInstallation from Source\n------------------------\n\nFor the latest development version, you can still clone the repository and install directly from the source:\n\n.. code-block:: bash\n\n git clone https://github.com/sysbio-curie/Neko.git\n cd Neko\n pip install .\n pip install -r requirements.txt\n\nThis 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.\n\nTroubleshooting\n---------------\n\nIf during the installation you encounter problems with the installation of Graphviz, you could be missing basic Graphiz installation on your machine.\nYou can install it on Linux system with the following command:\n\n.. code-block:: bash\n\n sudo apt-get install python3-dev graphviz libgraphviz-dev\n\nor on Mac system:\n\n.. code-block:: bash\n\n brew install python3-dev graphviz libgraphviz-dev\n\nFor more details visit: https://graphviz.org/download/\n\nDocumentation\n-------------\n\nFor full documentation, including API reference and detailed tutorials, visit our `GitHub Pages documentation <https://sysbio-curie.github.io/Neko/>`_.\n\nJupyter Notebooks\n-----------------\n\nWe 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:\n\n\n1) Usage\n2) Build network using user-defined resources\n3) Stepwise connection: a focus on the INE algorithm\n4) Connect to upstream components\n5) Build network based on kinase-phosphosite interactions\n6) Connect to downstream Gene Ontology terms.\n7) Map tissue expression\n8) Network comparison\n9) Re-creating famous pathways from SIGNOR and WIKIPATHWAYS using NeKo\n\n\nYou can find these notebooks in the `notebooks` directory of the repository.\n\nAcknowledgements\n----------------\n\nThis project is a collaborative effort between Institut Curie, NTNU, Saez lab and BSC.\n\nCurrent contributors: Marco Ruscone, Eirini Tsirvouli, Andrea Checcoli, D\u00e9nes Turei, Aasmund Flobak, Emmanuel Barillot, Loredana Martignetti, Julio Saez-Rodriguez and Laurence Calzone.\n\nversion 0.9.4\n--------------\n\n- 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.\n- 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.\n- Database translation: The package provides methods to convert the identifiers of a database storing edges list, into Uniprot.\n- 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.\n- 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. There is also an option to compress the network by substituting specified genes with the phenotype name.\n",
"bugtrack_url": null,
"license": "GNU General Public License Version 3",
"summary": "Package to extract, visualize, convert and study interactions from database into executable activity flow based model",
"version": "0.9.8",
"project_urls": {
"Bug Tracker": "https://github.com/sysbio-curie/Neko/issues",
"Documentation": "https://sysbio-curie.github.io/Neko/",
"Homepage": "https://github.com/sysbio-curie/Neko",
"Repository": "https://github.com/sysbio-curie/Neko"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85545f0dca68016363bff58b2afec6a2ed64cbb6f2ae382f4825befdeb08a039",
"md5": "0095e132a55d0f64203fc41cf889f337",
"sha256": "3a164d864af29b2e001b00558cc7cebab6acf8bb93c87fc0fb2c15cd920dc79f"
},
"downloads": -1,
"filename": "nekomata-0.9.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0095e132a55d0f64203fc41cf889f337",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 65902,
"upload_time": "2025-02-14T11:02:14",
"upload_time_iso_8601": "2025-02-14T11:02:14.947436Z",
"url": "https://files.pythonhosted.org/packages/85/54/5f0dca68016363bff58b2afec6a2ed64cbb6f2ae382f4825befdeb08a039/nekomata-0.9.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e0b3e0ab7a204a871650897b055f8ffd3497c5fc9850243883fab8b31ac2d20",
"md5": "c3c9ae36751304e8d8dbfd9772268070",
"sha256": "80a3ec38d44b825a682b84deef1974c9baf67d88a83b5c41d32447c740dfc27f"
},
"downloads": -1,
"filename": "nekomata-0.9.8.tar.gz",
"has_sig": false,
"md5_digest": "c3c9ae36751304e8d8dbfd9772268070",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 55776,
"upload_time": "2025-02-14T11:02:16",
"upload_time_iso_8601": "2025-02-14T11:02:16.367207Z",
"url": "https://files.pythonhosted.org/packages/6e/0b/3e0ab7a204a871650897b055f8ffd3497c5fc9850243883fab8b31ac2d20/nekomata-0.9.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-14 11:02:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sysbio-curie",
"github_project": "Neko",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "omnipath",
"specs": []
},
{
"name": "pypath-omnipath",
"specs": []
},
{
"name": "jupyter-contrib-nbextensions",
"specs": []
},
{
"name": "nbsphinx",
"specs": []
}
],
"tox": true,
"lcname": "nekomata"
}