snark-tool 0.4.0

snark-tool library contains structures and algorithm for (mainly) cubic graph analysis
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
65
66
67
68
69
70
71
72
73
74

# snark-tool

Snark tool is simple tool for snarks analysis. Snark is [cubic graph](https://en.wikipedia.org/wiki/Cubic_graph) with [girth](https://en.wikipedia.org/wiki/Girth_(graph_theory)) at least 5 and cyclic edge connectivity at least 4. 

## Use as library
Include snark-tool in your Cargo project by adding as a dependency to your Cargo.toml configuration file.

```toml
[dependencies]
...
snark-tool = "0.4.0"
```

Then simply use needed structs or functions in your code.

```rust
use crate::graph::undirected::simple_graph::graph::SimpleGraph;
use crate::service::io::reader_g6::G6Reader;

pub fn read_graph(graph_g6: &String) {
    let graph: SimpleGraph = G6Reader::read_graph(graph_g6).unwrap();
}
```

For more examples see [examples](https://github.com/jkbstrmen/snark-tool/tree/develop/examples) folder.

## Use as binary
At first [install cargo](https://www.rust-lang.org/learn/get-started). Then install snark-tool. 

    cargo install snark-tool

To run snark-tool at first we have to define configuration file in YAML format. Here we can specify what we want to do. 

```yaml
version: 0.1

procedures:
  - proc-type: read
    config:
      file: input-file.g6
      graph-format: g6

  # means regular 3-edge coloring
  - proc-type: colour
    config:
      colouriser-type: dfs

  - proc-type: write
    config:
      file: output.json
      graph-format: s6
      # if set to true, file format will be json for g6/s6 graph format
      with-properties: true # default true

  - proc-type: count
```
Basic usage is that snark-tool takes input file, read graphs from specified format. Then applies/perform specified procedures (in this case edge colouring) over graphs and at the end writes graphs to output file.

When we have specified configuration file with name snark-tool.yml we can start snark-tool using terminal command:

    snark-tool run snark-tool.yml

For full description of available procedures and its configuration see [procedures.md](https://github.com/jkbstrmen/snark-tool/blob/develop/procedures.md).

## License
Licensed under either of

- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

## To be noted
Package and all its parts are WIP. Package's API can change rapidly from version to version.