Skip to content

Latest commit

 

History

History
140 lines (86 loc) · 3.93 KB

README.rst

File metadata and controls

140 lines (86 loc) · 3.93 KB
Raw

Cell Maps PPI Embedder

The Cell Maps PPI Embedder is part of the Cell Mapping Toolkit

https://app.travis-ci.com/idekerlab/cellmaps_ppi_embedding.svg?branch=main Documentation Status Zenodo DOI badge

Generate embeddings from Protein-Protein interaction networks using node2vec

Dependencies

Compatibility

  • Python 3.8+

Installation

git clone https://github.com/idekerlab/cellmaps_ppi_embedding
cd cellmaps_ppi_embedding
make dist
pip install dist/cellmaps_ppi_embedding*whl

Run make command with no arguments to see other build/deploy options including creation of Docker image

make

Output:

clean                remove all build, test, coverage and Python artifacts
clean-build          remove build artifacts
clean-pyc            remove Python file artifacts
clean-test           remove test and coverage artifacts
lint                 check style with flake8
test                 run tests quickly with the default Python
test-all             run tests on every Python version with tox
coverage             check code coverage quickly with the default Python
docs                 generate Sphinx HTML documentation, including API docs
servedocs            compile the docs watching for changes
testrelease          package and upload a TEST release
release              package and upload a release
dist                 builds source and wheel package
install              install the package to the active Python's site-packages
dockerbuild          build docker image and store in local repository
dockerpush           push image to dockerhub

Before running tests, please install: pip install -r requirements_dev.txt.

For developers

To deploy development versions of this package

Below are steps to make changes to this code base, deploy, and then run against those changes.

  1. Make changes

    Modify code in this repo as desired

  2. Build and deploy

# From base directory of this repo cellmaps_ppi_embedding
pip uninstall cellmaps_ppi_embedding -y ; make clean dist; pip install dist/cellmaps_ppi_embedding*whl

Needed files

The output directory for the PPI download is required (see Cell Maps PPI Downloader).

Usage

For information invoke cellmaps_ppi_embeddingcmd.py -h

Example usage

cellmaps_ppi_embeddingcmd.py ./cellmaps_ppi_embedding_outdir --inputdir ./cellmaps_ppidownloader_outdir

Via Docker

Example usage

Coming soon ... ...

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.