webgraph-cli 0.4.1

Command line interface for the Rust port of the WebGraph framework (http://webgraph.di.unimi.it/).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# CLI for WebGraph

[![downloads](https://img.shields.io/crates/d/webgraph-cli)](https://crates.io/crates/webgraph-cli)
[![dependents](https://img.shields.io/librariesio/dependents/cargo/webgraph-cli)](https://crates.io/crates/webgraph-cli/reverse_dependencies)
![GitHub CI](https://github.com/vigna/webgraph-rs/actions/workflows/rust.yml/badge.svg)
![license](https://img.shields.io/crates/l/webgraph-cli)
[![Latest version](https://img.shields.io/crates/v/webgraph-cli.svg)](https://crates.io/crates/webgraph-cli)
[![Documentation](https://docs.rs/webgraph-cli/badge.svg)](https://docs.rs/webgraph-cli)

Command-line interface for the Rust implementation of the [WebGraph framework]
for graph compression.

This crate provides the `webgraph` CLI tool with various subcommands for working
with compressed graphs. The tool supports:

- **Building** accessory data structures (Elias-Fano offsets, DCF)
- **Converting** graphs between formats (arcs, ASCII, endianness)
- **Transforming** graphs (transpose, simplify)
- **Analyzing** graphs (code statistics)
- **Running** algorithms (Layered Label Propagation)
- **Benchmarking** graph operations

Each module corresponds to a group of commands, and each command is
implemented as a submodule.

## Subcommands

- `analyze`: computes statistics on graphs;
- `bench`: benchmark graph operations;
- `build`: builds accessory graph data structures;
- `check`: checks coherence of graph files;
- `from`: ingests data into graphs;
- `perm`: creates and manipulates permutations;
- `run`: runs algorithms on graph;
- `to`: converts graphs between representations;
- `transform`: applies transformations to graphs.

## Separate Binaries

This crate also provides specialized standalone binaries:

- `webgraph-dist`: tools for computing graph properties based on distances,
  including measures of centrality (HyperBall, ExactSumSweep);
- `webgraph-sccs`: computes strongly connected components;
- `webgraph-rank`: computes centrality measures on graphs.

## Environment Variables

- `RUST_MIN_STACK`: Minimum thread stack size (in bytes); we suggest
  `RUST_MIN_STACK=8388608` (8MiB)
- `TMPDIR`: Where to store temporary files (potentially very large ones)
- `RUST_LOG`: Configuration for [`env_logger`]

## Acknowledgments

This software has been partially supported by project SERICS (PE00000014) under
the NRRP MUR program funded by the EU - NGEU, and by project ANR COREGRAPHIE,
grant ANR-20-CE23-0002 of the French Agence Nationale de la Recherche. Views and
opinions expressed are however those of the authors only and do not necessarily
reflect those of the European Union or the Italian MUR. Neither the European
Union nor the Italian MUR can be held responsible for them.

[WebGraph framework]: https://webgraph.di.unimi.it/
[`env_logger`]: https://docs.rs/env_logger/latest/env_logger/