stoufferlab / pymfinder

A Python package with which to find network motifs in complex networks and to analyze a growing list of network-motif related stuff.
MIT License
16 stars 7 forks source link

pymfinder

pymfinder is Python package with which to find network motifs in complex networks and to analyze a growing list of network-motif related stuff.

At its core, pymfinder is a Python library that combines Python methods for network-motif analysis. pymfinder will require you to have the Python modules Numpy and Setuptools installed in your machine. In addition, some of the engine underneath is a modified version of original mfinder version 1.2 written in C and available on Uri Alon's website. mfinder is a software tool for network-motif detection developed by Nadav Kashtan, and it was originally written in C and made available solely as an executable. We use mfinder within pymfinder for its underlying efficiency. The mfinder code has been both included and modified here with the explicit consent of Nadav Kashtan, the author of mfinder 1.2.

If you use pymfinder or the ideas presented in it, please remember to cite Bramon Mora, et. al. 2018.

Installation instructions

Installation should be relatively straightforward using the included setup.py. In fact, it should be as simple as navigating to the directory where you cloned the git repository ('pymfinder/') and running

python setup.py install

If you receive an error about 'Permission denied' or something similar, you most likely don't have permission to install pymfinder in the global Python site-packages or dist-packages directory. In that case, you can install it locally by adding the --user option

python setup.py install --user

If you still cannot install pymfinder, please check the issues page and, if your problem isn't listed, create a new one.

If you prefer to use Python 3, you can also switch to the branch pymfinder-python3.

Checking the installation

Assuming that the package installs properly, it is strongly recommended that you run the test suite to make sure that nothing fishy is going on. Doing so is as simple as running

python setup.py test