plaquette-graph 0.0.1a0

No project description provided

Table of Contents

• About

• Installation

• Usage

  • Python Frontend

  • C++ Backend

About

The plaquette-graph plugin extends the Plaquette error correction software, providing a fast graph library written in C++.

Installation

The C++ tests/examples and python bindings can be built independently by

cmake -Bbuild -G Ninja -DPLAQUETTE_GRAPH_BUILD_TESTS=On -DPLAQUETTE_GRAPH_BUILD_BINDINGS=On
cmake --build ./build

You can run the C++ backend tests with

make test-cpp

You can install just the python interface with (this quietly builds the C++ backend):

pip install -r requirements.txt
pip install .

or get the latest stable release from PyPI

pip install plaquette_graph

You can run the python frontend tests with

make test-python

To generate the documentation you will need to install graphviz and doxygen. Then run

pip install -r doc/requirements.txt
make docs
firefox ./doc/_build/html/index.html

Usage

The primary graph class is SparseGraph, an undirected immutable graph structure stored in CSR format for extremely fast lookup of neighbouring vertices and edges. See the documentation for other types of graphs we support.

Python Frontend

import plaquette_graph as pg

edges = [(0, 1), (0, 2), (1, 2)]
num_vertices = 3
graph = pg.SparseGraph(num_vertices, edges)

C++ Backend

#include "SparseGraph.hpp"

int main(int argc, char *argv[]) {

  using namespace Plaquette;
  std::vector<std::pair<size_t,size_t>> edges = {{0,1},{0,2},{1,2}};
  size_t num_vertices = 3;
  auto graph = SparseGraph(num_vertices, edges);

}