Skip to main content

Approximate fuzzy subgraph matching in polynomial time

Project description

Fornax

CircleCI Coverage Status Known Vulnerabilities Documentation Status

An implementation of NeMa: Fast Graph Search with Label Similarity using python3 and sqlite or postgres.

FORNAX

Install

Via pip:

pip install fornax

Note that Fornax requires numpy to be installed (part of the SciPy ecosystem) which in turn has non python dependencies. The available options for installing SciPy packages are listed here.

We recomend installing fornax via anaconda

conda create --name myenv python=3.6
source activate myenv
pip install fornax

Install (Dev)

From the root directory:

# install dev dependencies
pip install -r requirements/dev.txt

# install fornax
pip install -e .

View the Docs

View the docs at: fornax.readthedocs.io

Test

From the root directory

python run_test.py

Tutorials

See the tutorials for a full working example.

  • Part 1 - Download a small graph dataset
  • Part 2 - Search the dataset using fornax

Install Tutorial Dependencies (using conda)

The following tutorials use jupyter notebooks to create a worked example. We recommend you use the anaconda python distribution to run the notebooks.

conda env create -f environment.yml

Run the Tutorials

source activate fornax_tutorial
cd docs/tutorial
jupyter-notebook

Documentation

Build the Docs

# install docs dependencies
pip install -r requirements/docs.txt
# install fornax
pip install .

# build
cd docs
make html

View the Docs Locally

cd _build/html
python3 -m http.server

navigate to 0.0.0.0:8000 in your browser.

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

fornax-0.1.1.tar.gz (24.7 kB view hashes)

Uploaded source

Built Distribution

fornax-0.1.1-py3-none-any.whl (30.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page