Skip to content

fhaive/VOLTA

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VOLTA: adVanced mOLecular neTwork Analysis

VOLTA is a Python network analysis package, suited for different types of networks but with a focus on co-expression network analysis. The goal of VOLTA is to provide all functionalities needed for a comprehensive network analysis and comparison in a single package. Its aim is to expose all functionalities in order to allow users to build their own analysis pipelines and adjust functionalities as needed. Additional complete analysis pipelines are provided in the form of Jupyter Notebooks.

How do I get set up?

Dependencies

Prerequisites

  • Install python-igraph . Based on your system there may be specific Prerequisites to fulfill. Refer to the igraph instructions for these.
  • For windows users please install the optional requirements as instructed here: https://github.com/GiulioRossetti/cdlib , else some of the community algorithms will not be available

VOTLA has been tested on Linux, Mac and Windows systems for Python 3.6+.

Install

Depending on your system you may receive an "invalid command bdist_wheel" error. You can fix this by installing the wheel package. pip3 install wheel

It may be advisable to install the application in a virtual environment. Please refer to the installation and setup instructions from the provider. Conda: https://conda.io/projects/conda/en/latest/user-guide/getting-started.html Python Virtual Environment: https://docs.python.org/3/tutorial/venv.html

To run the example pipelines a Jupyter Notebooks server needs to be installed (https://jupyter.org/install).

Installation via Conda: conda install -c conda-forge jupyterlab Installation via pip: pip3 install jupyterlab

Start with jupyter notebook in a terminal.

Usage

  • import volta

In the jupyternotebooks folder different examples on how to use VOLTA as well as complete analysis pipleines for co-expression network analysis are provided. Test networks that are automatically read into the example pipelines are provided in the networks folder. VOLTA requires networks to be provided in the form of NetworkX graph objects. A Jupyter Notebook file is provided, showing how different network formats can be converted into the required graph object.

For detailed function information refer to the documentation, which is provided as HTML in the html folder.

More information about VOLTA can be found in the corresponding publication:

How to cite VOLTA

License

VOLTA is published under a GNU GENERAL PUBLIC LICENSE Version 3 license. Individual parts may underly a differet license, for this please refer to the package providers.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages