honeycomb_examples/lib.rs
1//! # honeycomb-examples
2//!
3//! This crate contains all examples of the project.
4//!
5//! ## Available examples
6//!
7//! ### Algorithm
8//!
9//! - `grisubal` -- Run the grisubal algorithm on a specified input.
10//! - `parallel_shift` -- Run a simple parallel vertex relaxation routine that highlights usage of
11//! the STM model.
12//!
13//! ### Input / Output
14//!
15//! - `io_read` -- Initialize and render a map from the VTK file passed to the command line.
16//! - `io_write` -- Serialize a map representing a grid with quads randomly split diagonally.
17//! The output file can be visualized using ParaView and compared to the render.
18//!
19//! ### Rendering
20//!
21//! - `render` -- Render a map representing a simple orthogonal grid. Note that you may *need* to
22//! run this example in release mode.